Package com.ngrok.services

Class SshUserCertificates.UpdateCallBuilder

java.lang.Object

com.ngrok.services.SshUserCertificates.UpdateCallBuilder

Enclosing class:

SshUserCertificates

public class SshUserCertificates.UpdateCallBuilder
extends Object

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

description

public SshUserCertificates.UpdateCallBuilder description(String description)

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

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

human-readable description of this SSH User 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 SshUserCertificates.UpdateCallBuilder metadata(String metadata)

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

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

arbitrary user-defined machine-readable data of this SSH User 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<SshUserCertificate> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of SshUserCertificate

blockingCall

public SshUserCertificate blockingCall()
                                throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

SshUserCertificate

Throws:

InterruptedException - if the thread was interrupted during the call