Package com.oracle.bmc.apigateway.model

Class Gateway

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

    • Method Detail

      • getId

        public String getId()
        The OCID of the resource.
        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.

        Example: My new resource

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment in which the resource is created.
        Returns:
        the value

      • getEndpointType

        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

        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet in which related resources are created.
        Returns:
        the value

      • getNetworkSecurityGroupIds

        public List<String> getNetworkSecurityGroupIds()
        An array of Network Security Groups OCIDs associated with this API Gateway.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time this resource was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time this resource was last updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getLifecycleState

        public Gateway.LifecycleState getLifecycleState()
        The current state of the gateway.
        Returns:
        the value

      • getLifecycleDetails

        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.

        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        Returns:
        the value

      • getHostname

        public String getHostname()
        The hostname for APIs deployed on the gateway.
        Returns:
        the value

      • getCertificateId

        public String getCertificateId()
        The OCID of the resource.
        Returns:
        the value

      • getIpAddresses

        public List<IpAddress> getIpAddresses()
        An array of IP addresses associated with the gateway.
        Returns:
        the value

      • getFreeformTags

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

        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. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value

      • getCaBundles

        public List<CaBundle> getCaBundles()
        An array of CA bundles that should be used on the Gateway for TLS validation.
        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