@Generated(value="OracleSDKGenerator",
comments="API Version: 20190501")
public final class Gateway
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A gateway is a virtual network appliance in a regional subnet. A gateway routes inbound traffic
to back-end services including public, private, and partner HTTP APIs, as well as Oracle
Functions. Avoid entering confidential information. For more information, see API Gateway
Concepts.
Note: Objects should always be created or deserialized using the Gateway.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 Gateway.Builder, which maintain a
set of all explicitly set fields called Gateway.Builder.__explicitlySet__. The hashCode() and equals(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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Gateway.Builder |
static class |
Gateway.EndpointType
Gateway endpoint type.
|
static class |
Gateway.LifecycleState
The current state of the gateway.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Gateway(String id,
String displayName,
String compartmentId,
Gateway.EndpointType endpointType,
String subnetId,
List<String> networkSecurityGroupIds,
Date timeCreated,
Date timeUpdated,
Gateway.LifecycleState lifecycleState,
String lifecycleDetails,
String hostname,
String certificateId,
List<IpAddress> ipAddresses,
ResponseCacheDetails responseCacheDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
List<CaBundle> caBundles)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Gateway.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
List<CaBundle> |
getCaBundles()
An array of CA bundles that should be used on the Gateway for TLS validation.
|
String |
getCertificateId()
The OCID of the
resource.
|
String |
getCompartmentId()
The OCID of the
compartment in which the resource is created.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
Gateway.EndpointType |
getEndpointType()
Gateway endpoint type.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getHostname()
The hostname for APIs deployed on the gateway.
|
String |
getId()
The OCID of the
resource.
|
List<IpAddress> |
getIpAddresses()
An array of IP addresses associated with the gateway.
|
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
Gateway.LifecycleState |
getLifecycleState()
The current state of the gateway.
|
List<String> |
getNetworkSecurityGroupIds()
An array of Network Security Groups OCIDs associated with this API Gateway.
|
ResponseCacheDetails |
getResponseCacheDetails() |
String |
getSubnetId()
The OCID of the
subnet in which related resources are created.
|
Date |
getTimeCreated()
The time this resource was created.
|
Date |
getTimeUpdated()
The time this resource was last updated.
|
int |
hashCode() |
Gateway.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","endpointType","subnetId","networkSecurityGroupIds","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","hostname","certificateId","ipAddresses","responseCacheDetails","freeformTags","definedTags","caBundles"}) public Gateway(String id, String displayName, String compartmentId, Gateway.EndpointType endpointType, String subnetId, List<String> networkSecurityGroupIds, Date timeCreated, Date timeUpdated, Gateway.LifecycleState lifecycleState, String lifecycleDetails, String hostname, String certificateId, List<IpAddress> ipAddresses, ResponseCacheDetails responseCacheDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<CaBundle> caBundles)
public static Gateway.Builder builder()
Create a new builder.
public Gateway.Builder toBuilder()
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: My new resource
public String getCompartmentId()
The OCID of the compartment in which the resource is created.
public Gateway.EndpointType getEndpointType()
Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while
PRIVATE will only be accessible on a private IP address on the subnet.
Example: PUBLIC or PRIVATE
public String getSubnetId()
The OCID of the subnet in which related resources are created.
public List<String> getNetworkSecurityGroupIds()
An array of Network Security Groups OCIDs associated with this API Gateway.
public Date getTimeCreated()
The time this resource was created. An RFC3339 formatted datetime string.
public Date getTimeUpdated()
The time this resource was last updated. An RFC3339 formatted datetime string.
public Gateway.LifecycleState getLifecycleState()
The current state of the gateway.
public String getLifecycleDetails()
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
public String getHostname()
The hostname for APIs deployed on the gateway.
public List<IpAddress> getIpAddresses()
An array of IP addresses associated with the gateway.
public ResponseCacheDetails getResponseCacheDetails()
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 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 List<CaBundle> getCaBundles()
An array of CA bundles that should be used on the Gateway for TLS validation.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.