Class Connection

  • Direct Known Subclasses:
    MysqlConnection, OracleConnection

    @Generated(value="OracleSDKGenerator",
               comments="API Version: 20230518")
    public class Connection
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Represents the common details required for creating a new connection.
    Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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 connection being referenced.
        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
      • getDescription

        public String getDescription()
        A user-friendly description.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        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. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value
      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        Usage of system tag keys.

        These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Returns:
        the value
      • getLifecycleState

        public Connection.LifecycleState getLifecycleState()
        The Connection’s current lifecycle state.
        Returns:
        the value
      • getLifecycleDetails

        public String getLifecycleDetails()
        The message describing the current state of the connection’s lifecycle in detail.

        For example, can be used to provide actionable information for a connection in a Failed state.

        Returns:
        the value
      • getTimeCreated

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

        An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

        Returns:
        the value
      • getTimeUpdated

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

        An RFC3339 formatted datetime string such as 2016-08-25T21:10:29.600Z.

        Returns:
        the value
      • getVaultId

        public String getVaultId()
        OCI resource ID.
        Returns:
        the value
      • getKeyId

        public String getKeyId()
        The OCID of the key used in cryptographic operations.
        Returns:
        the value
      • getSubnetId

        public String getSubnetId()
        OCI resource ID.
        Returns:
        the value
      • getIngressIps

        public List<IngressIpDetails> getIngressIps()
        List of ingress IP addresses from where to connect to this connection’s privateIp.
        Returns:
        the value
      • getNsgIds

        public List<String> getNsgIds()
        An array of Network Security Group OCIDs used to define network access for Connections.
        Returns:
        the value
      • getUsername

        public String getUsername()
        The username (credential) used when creating or updating this resource.
        Returns:
        the value
      • getPassword

        public String getPassword()
        The password (credential) used when creating or updating this resource.
        Returns:
        the value
      • getReplicationUsername

        public String getReplicationUsername()
        The username (credential) used when creating or updating this resource.
        Returns:
        the value
      • getReplicationPassword

        public String getReplicationPassword()
        The password (credential) used when creating or updating this resource.
        Returns:
        the value
      • getSecretId

        public String getSecretId()
        The OCID of the resource being referenced.
        Returns:
        the value
      • getPrivateEndpointId

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