Package com.oracle.bmc.streaming.model

Class StreamPool

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public final class StreamPool
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The details of a stream pool.
    Note: Objects should always be created or deserialized using the StreamPool.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 StreamPool.Builder, which maintain a set of all explicitly set fields called StreamPool.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 stream pool.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Compartment OCID that the pool belongs to.
        Returns:
        the value

      • getName

        public String getName()
        The name of the stream pool.
        Returns:
        the value

      • getLifecycleState

        public StreamPool.LifecycleState getLifecycleState()
        The current state of the stream pool.
        Returns:
        the value

      • getLifecycleStateDetails

        public String getLifecycleStateDetails()
        Any additional details about the current state of the stream.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the stream pool was created, expressed in in RFC 3339 timestamp format.

        Example: 2018-04-20T00:00:07.405Z

        Returns:
        the value

      • getIsPrivate

        public Boolean getIsPrivate()
        True if the stream pool is private, false otherwise.

        If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.

        Returns:
        the value

      • getEndpointFqdn

        public String getEndpointFqdn()
        The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object).

        If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.

        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. Exists for cross-compatibility only. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getSecurityAttributes

        public Map<String,​Map<String,​Object>> getSecurityAttributes()
        Security attributes for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

        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

      • 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