Package com.oracle.bmc.managedkafka.model

Class KafkaCluster

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240901")
public final class KafkaCluster
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A KafkaCluster is a description of a KafkaCluster.

    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/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the KafkaCluster.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 KafkaCluster.Builder, which maintain a set of all explicitly set fields called KafkaCluster.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 KafkaCluster.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the KafkaCluster was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the KafkaCluster was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the KafkaCluster in more detail.

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

        Returns:
        the value

      • getAccessSubnets

        public List<SubnetSet> getAccessSubnets()
        Subnets where broker/coordinator VNICs will be created.
        Returns:
        the value

      • getClientCertificateBundle

        public String getClientCertificateBundle()
        CA certificate bundle for mTLS broker authentication.
        Returns:
        the value

      • getKafkaVersion

        public String getKafkaVersion()
        Version of Kafka to use to spin up the cluster
        Returns:
        the value

      • getClusterType

        public KafkaCluster.ClusterType getClusterType()
        Type of the cluster to spin up.

        DEVELOPMENT - setting that allows to sacrifice HA and spin up cluster on a single node PRODUCTION - Minimum allowed broker count is 3

        Returns:
        the value

      • getClusterConfigId

        public String getClusterConfigId()
        The OCID of Kafka Cluster configuration object
        Returns:
        the value

      • getClusterConfigVersion

        public Integer getClusterConfigVersion()
        The version of configuration object
        Returns:
        the value

      • getKafkaBootstrapUrls

        public List<BootstrapUrl> getKafkaBootstrapUrls()
        Bootstrap URL that can be used to connect to Kafka
        Returns:
        the value

      • getCoordinationType

        public KafkaCluster.CoordinationType getCoordinationType()
        Kafka coordination type.

        Set of available types depends on Kafka version

        Returns:
        the value

      • getSecretId

        public String getSecretId()
        The OCID of the secret that contains superuser password.
        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

      • 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