Interface NodeGroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<NodeGroup.Builder,NodeGroup>, SdkBuilder<NodeGroup.Builder,NodeGroup>, SdkPojo
Enclosing class:
NodeGroup
public static interface NodeGroup.Builder extends SdkPojo, CopyableBuilder<NodeGroup.Builder,NodeGroup>

  • Method Details

    • nodeGroupId

      NodeGroup.Builder nodeGroupId(String nodeGroupId)

      The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

      Parameters:
      nodeGroupId - The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      NodeGroup.Builder status(String status)

      The current state of this replication group - creating, available, modifying, deleting.

      Parameters:
      status - The current state of this replication group - creating, available, modifying, deleting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryEndpoint

      NodeGroup.Builder primaryEndpoint(Endpoint primaryEndpoint)

      The endpoint of the primary node in this node group (shard).

      Parameters:
      primaryEndpoint - The endpoint of the primary node in this node group (shard).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryEndpoint

      default NodeGroup.Builder primaryEndpoint(Consumer<Endpoint.Builder> primaryEndpoint)

      The endpoint of the primary node in this node group (shard).

      This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to primaryEndpoint(Endpoint).

      Parameters:
      primaryEndpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • readerEndpoint

      NodeGroup.Builder readerEndpoint(Endpoint readerEndpoint)

      The endpoint of the replica nodes in this node group (shard). This value is read-only.

      Parameters:
      readerEndpoint - The endpoint of the replica nodes in this node group (shard). This value is read-only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readerEndpoint

      default NodeGroup.Builder readerEndpoint(Consumer<Endpoint.Builder> readerEndpoint)

      The endpoint of the replica nodes in this node group (shard). This value is read-only.

      This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to readerEndpoint(Endpoint).

      Parameters:
      readerEndpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • slots

      NodeGroup.Builder slots(String slots)

      The keyspace for this node group (shard).

      Parameters:
      slots - The keyspace for this node group (shard).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeGroupMembers

      NodeGroup.Builder nodeGroupMembers(Collection<NodeGroupMember> nodeGroupMembers)

      A list containing information about individual nodes within the node group (shard).

      Parameters:
      nodeGroupMembers - A list containing information about individual nodes within the node group (shard).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeGroupMembers

      NodeGroup.Builder nodeGroupMembers(NodeGroupMember... nodeGroupMembers)

      A list containing information about individual nodes within the node group (shard).

      Parameters:
      nodeGroupMembers - A list containing information about individual nodes within the node group (shard).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeGroupMembers

      NodeGroup.Builder nodeGroupMembers(Consumer<NodeGroupMember.Builder>... nodeGroupMembers)

      A list containing information about individual nodes within the node group (shard).

      This is a convenience method that creates an instance of the NodeGroupMember.Builder avoiding the need to create one manually via NodeGroupMember.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeGroupMembers(List<NodeGroupMember>).

      Parameters:
      nodeGroupMembers - a consumer that will call methods on NodeGroupMember.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: