Class ServiceGateway

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 {@link #listServices(ListServicesRequest) 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.

Inheritance
object
ServiceGateway
Inherited Members
Namespace: Oci.CoreService.Models
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class ServiceGateway

Properties

BlockTraffic

Declaration
[Required(ErrorMessage = "BlockTraffic is required.")]
[JsonProperty(PropertyName = "blockTraffic")]
public bool? BlockTraffic { get; set; }
Property Value
Type Description
bool?

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
Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains the service gateway.
Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the service gateway.
Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ServiceGateway.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
ServiceGateway.LifecycleStateEnum?

The service gateway's current state.
Remarks

Required

RouteTableId

Declaration
[JsonProperty(PropertyName = "routeTableId")]
public string RouteTableId { get; set; }
Property Value
Type Description
string

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.

Services

Declaration
[Required(ErrorMessage = "Services is required.")]
[JsonProperty(PropertyName = "services")]
public List<ServiceIdResponseDetails> Services { get; set; }
Property Value
Type Description
List<ServiceIdResponseDetails>

List of the {@link Service} objects enabled for this service gateway. The list can be empty. You can enable a particular Service by using {@link #attachServiceId(AttachServiceIdRequest) attachServiceId} or {@link #updateServiceGateway(UpdateServiceGatewayRequest) updateServiceGateway}.
Remarks

Required

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the service gateway was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z

VcnId

Declaration
[Required(ErrorMessage = "VcnId is required.")]
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }
Property Value
Type Description
string

The OCID of the VCN the service gateway belongs to.
Remarks

Required