Package com.ngrok.services

Class SshHostCertificates.UpdateCallBuilder

java.lang.Object

com.ngrok.services.SshHostCertificates.UpdateCallBuilder

Enclosing class:

SshHostCertificates

public class SshHostCertificates.UpdateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
SshHostCertificate	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<SshHostCertificate>	call()	Initiates the API call asynchronously.
SshHostCertificates.UpdateCallBuilder	description(String description)	human-readable description of this SSH Host Certificate.
SshHostCertificates.UpdateCallBuilder	description(Optional<String> description)	human-readable description of this SSH Host Certificate.
SshHostCertificates.UpdateCallBuilder	metadata(String metadata)	arbitrary user-defined machine-readable data of this SSH Host Certificate.
SshHostCertificates.UpdateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined machine-readable data of this SSH Host Certificate.

Methods inherited from class java.lang.Object

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

Method Details

description

public SshHostCertificates.UpdateCallBuilder description(String description)

human-readable description of this SSH Host Certificate. optional, max 255 bytes.

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

human-readable description of this SSH Host Certificate. optional, max 255 bytes.

Parameters:

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

Returns:

the call builder instance

metadata

public SshHostCertificates.UpdateCallBuilder metadata(String metadata)

arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

arbitrary user-defined machine-readable data of this SSH Host Certificate. 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<SshHostCertificate> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of SshHostCertificate

blockingCall

public SshHostCertificate blockingCall()
                                throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

SshHostCertificate

Throws:

InterruptedException - if the thread was interrupted during the call