Class LocalPeeringGateway
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.vnmonitoring.model.LocalPeeringGateway
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class LocalPeeringGateway extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using theLocalPeeringGateway.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 theLocalPeeringGateway.Builder
, which maintain a set of all explicitly set fields calledLocalPeeringGateway.Builder.__explicitlySet__
. ThehashCode()
andequals(Object)
methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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 Summary
Constructors Constructor 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 peerId, String routeTableId, Date timeCreated, String vcnId)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LocalPeeringGateway.Builder
builder()
Create a new builder.boolean
equals(Object o)
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()
Simple key-value pair that is applied without any predefined name, type or scope.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.String
getPeerId()
The OCID of the peered 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()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
LocalPeeringGateway
@Deprecated @ConstructorProperties({"compartmentId","definedTags","displayName","freeformTags","id","isCrossTenancyPeering","lifecycleState","peerAdvertisedCidr","peerAdvertisedCidrDetails","peeringStatus","peeringStatusDetails","peerId","routeTableId","timeCreated","vcnId"}) 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 peerId, String routeTableId, Date timeCreated, String vcnId)
Deprecated.
-
-
Method Detail
-
builder
public static LocalPeeringGateway.Builder builder()
Create a new builder.
-
toBuilder
public LocalPeeringGateway.Builder toBuilder()
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment containing the LPG.- Returns:
- the value
-
getDefinedTags
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource.Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns:
- the value
-
getDisplayName
public String getDisplayName()
A user-friendly name.Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns:
- the value
-
getFreeformTags
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- Returns:
- the value
-
getIsCrossTenancyPeering
public Boolean getIsCrossTenancyPeering()
Whether the VCN at the other end of the peering is in a different tenancy.Example: false
- Returns:
- the value
-
getLifecycleState
public LocalPeeringGateway.LifecycleState getLifecycleState()
The LPG’s current lifecycle state.- Returns:
- the value
-
getPeerAdvertisedCidr
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
- Returns:
- the value
-
getPeerAdvertisedCidrDetails
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]
- Returns:
- the value
-
getPeeringStatus
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.
- Returns:
- the value
-
getPeeringStatusDetails
public String getPeeringStatusDetails()
Additional information regarding the peering status, if applicable.- Returns:
- the value
-
getRouteTableId
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.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).
- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The date and time the LPG was created, in the format defined by RFC3339.Example: 2016-08-25T21:10:29.600Z
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toString
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents
- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-