@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class ServiceGateway extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Represents a router that lets your VCN privately access specific Oracle services such as Object
Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined for
a supported Oracle service (use the listServices
operation to find available service CIDR labels) is routed through the service gateway and does
not traverse the internet. The instances in the VCN do not need to have public IP addresses nor
be in a public subnet. The VCN does not need an internet gateway for this traffic. For more
information, see Access to Oracle Services: Service
Gateway.
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 ServiceGateway.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 ServiceGateway.Builder
, which maintain a
set of all explicitly set fields called ServiceGateway.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 |
ServiceGateway.Builder |
static class |
ServiceGateway.LifecycleState
The service gateway’s current state.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
ServiceGateway(Boolean blockTraffic,
String compartmentId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,String> freeformTags,
String id,
ServiceGateway.LifecycleState lifecycleState,
String routeTableId,
List<ServiceIdResponseDetails> services,
Date timeCreated,
String vcnId)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static ServiceGateway.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Boolean |
getBlockTraffic()
Whether the service gateway blocks all traffic through it.
|
String |
getCompartmentId()
The OCID of
the compartment that contains the service gateway.
|
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 OCID of
the service gateway.
|
ServiceGateway.LifecycleState |
getLifecycleState()
The service gateway’s current state.
|
String |
getRouteTableId()
The OCID of
the route table the service gateway is using.
|
List<ServiceIdResponseDetails> |
getServices()
List of the
Service objects enabled for this service gateway. |
Date |
getTimeCreated()
The date and time the service gateway was created, in the format defined by
RFC3339.
|
String |
getVcnId()
The OCID of
the VCN the service gateway belongs to.
|
int |
hashCode() |
ServiceGateway.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"blockTraffic","compartmentId","definedTags","displayName","freeformTags","id","lifecycleState","routeTableId","services","timeCreated","vcnId"}) public ServiceGateway(Boolean blockTraffic, String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, ServiceGateway.LifecycleState lifecycleState, String routeTableId, List<ServiceIdResponseDetails> services, Date timeCreated, String vcnId)
public static ServiceGateway.Builder builder()
Create a new builder.
public ServiceGateway.Builder toBuilder()
public Boolean getBlockTraffic()
Whether the service gateway blocks all traffic through it. The default is false
. When
this is true
, traffic is not routed to any services, regardless of route rules.
Example: true
public String getCompartmentId()
The OCID of the compartment that contains the service gateway.
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 ServiceGateway.LifecycleState getLifecycleState()
The service gateway’s current state.
public String getRouteTableId()
The OCID of the route table the service gateway is using. For information about why you would associate a route table with a service gateway, see Transit Routing: Private Access to Oracle Services.
public List<ServiceIdResponseDetails> getServices()
List of the Service
objects enabled for this service gateway. The list can be empty.
You can enable a particular Service
by using attachServiceId
or updateServiceGateway
.
public Date getTimeCreated()
The date and time the service gateway was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public String getVcnId()
The OCID of the VCN the service gateway belongs to.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.