Package com.oracle.bmc.vnmonitoring.model

Class ServiceGateway

  • @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 (see listServices) 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.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).

    • Method Detail

      • getBlockTraffic

        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

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the service gateway.
        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

      • getId

        public String getId()
        The OCID of the service gateway.
        Returns:
        the value

      • getServices

        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.

        Returns:
        the value

      • getTimeCreated

        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

        Returns:
        the value

      • getVcnId

        public String getVcnId()
        The OCID of the VCN the service gateway belongs to.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.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 class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel