Class Stream.Builder

  • Enclosing class:
    Stream

    public static class Stream.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • name

        public Stream.Builder name​(String name)
        The name of the stream.

        Avoid entering confidential information.

        Example: TelemetryEvents

        Parameters:
        name - the value to set
        Returns:
        this builder
      • id

        public Stream.Builder id​(String id)
        The OCID of the stream.
        Parameters:
        id - the value to set
        Returns:
        this builder
      • partitions

        public Stream.Builder partitions​(Integer partitions)
        The number of partitions in the stream.
        Parameters:
        partitions - the value to set
        Returns:
        this builder
      • retentionInHours

        public Stream.Builder retentionInHours​(Integer retentionInHours)
        The retention period of the stream, in hours.

        This property is read-only.

        Parameters:
        retentionInHours - the value to set
        Returns:
        this builder
      • compartmentId

        public Stream.Builder compartmentId​(String compartmentId)
        The OCID of the stream.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder
      • streamPoolId

        public Stream.Builder streamPoolId​(String streamPoolId)
        The OCID of the stream pool that contains the stream.
        Parameters:
        streamPoolId - the value to set
        Returns:
        this builder
      • lifecycleState

        public Stream.Builder lifecycleState​(Stream.LifecycleState lifecycleState)
        The current state of the stream.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • lifecycleStateDetails

        public Stream.Builder lifecycleStateDetails​(String lifecycleStateDetails)
        Any additional details about the current state of the stream.
        Parameters:
        lifecycleStateDetails - the value to set
        Returns:
        this builder
      • timeCreated

        public Stream.Builder timeCreated​(Date timeCreated)
        The date and time the stream was created, expressed in in RFC 3339 timestamp format.

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • messagesEndpoint

        public Stream.Builder messagesEndpoint​(String messagesEndpoint)
        The endpoint to use when creating the StreamClient to consume or publish messages in the stream.

        If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool’s associated subnet.

        Parameters:
        messagesEndpoint - the value to set
        Returns:
        this builder
      • freeformTags

        public Stream.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

        public Stream.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

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

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

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • build

        public Stream build()