Package org.opensearch.client.opensearch.ism

Class Channel.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ism.Channel.Builder

All Implemented Interfaces:

CopyableBuilder<Channel.Builder,Channel>, MutableBuilder<Channel.Builder,Channel>, ObjectBuilder<Channel>

Enclosing class:

Channel

public static class Channel.Builder
extends ObjectBuilderBase
implements CopyableBuilder<Channel.Builder,Channel>

Builder for Channel.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Channel	build()	Builds a Channel.
Channel.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Channel.Builder	id(String value)	The ID of the notification channel.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public Channel.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<Channel.Builder,Channel>

Returns:

a new builder instance.

id

@Nonnull
public final Channel.Builder id(@Nullable
 String value)

The ID of the notification channel.

API name: id

build

@Nonnull
public Channel build()

Builds a Channel.

Specified by:

build in interface ObjectBuilder<Channel>

Throws:

NullPointerException - if some of the required fields are null.