Package com.ngrok.services

Class ReservedAddrs.UpdateCallBuilder

java.lang.Object

com.ngrok.services.ReservedAddrs.UpdateCallBuilder

Enclosing class:

ReservedAddrs

public class ReservedAddrs.UpdateCallBuilder
extends Object

A builder object encapsulating state for an unsent Update API call.

Method Summary

Modifier and Type	Method	Description
ReservedAddr	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<ReservedAddr>	call()	Initiates the API call asynchronously.
ReservedAddrs.UpdateCallBuilder	description(String description)	human-readable description of what this reserved address will be used for
ReservedAddrs.UpdateCallBuilder	description(Optional<String> description)	human-readable description of what this reserved address will be used for
ReservedAddrs.UpdateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this reserved address.
ReservedAddrs.UpdateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this reserved address.

Methods inherited from class java.lang.Object

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

Method Details

description

public ReservedAddrs.UpdateCallBuilder description(String description)

human-readable description of what this reserved address will be used for

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

public ReservedAddrs.UpdateCallBuilder description(Optional<String> description)

human-readable description of what this reserved address will be used for

Parameters:

description - the value of the description parameter as an Optional of String

Returns:

the call builder instance

metadata

public ReservedAddrs.UpdateCallBuilder metadata(String metadata)

arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

public ReservedAddrs.UpdateCallBuilder metadata(Optional<String> metadata)

arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.

Parameters:

metadata - the value of the metadata parameter as an Optional of String

Returns:

the call builder instance

call

public CompletionStage<ReservedAddr> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of ReservedAddr

blockingCall

public ReservedAddr blockingCall()
                          throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

ReservedAddr

Throws:

InterruptedException - if the thread was interrupted during the call