Package com.ngrok.services

Class SshCertificateAuthorities.UpdateCallBuilder

java.lang.Object

com.ngrok.services.SshCertificateAuthorities.UpdateCallBuilder

Enclosing class:

SshCertificateAuthorities

public class SshCertificateAuthorities.UpdateCallBuilder
extends Object

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

description

public SshCertificateAuthorities.UpdateCallBuilder description(String description)

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

Parameters:

description - the value of the description parameter as a String

Returns:

the call builder instance

description

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

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

Parameters:

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

Returns:

the call builder instance

metadata

public SshCertificateAuthorities.UpdateCallBuilder metadata(String metadata)

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

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

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

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

Initiates the API call asynchronously.

Returns:

a CompletionStage of SshCertificateAuthority

blockingCall

public SshCertificateAuthority blockingCall()
                                     throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

SshCertificateAuthority

Throws:

InterruptedException - if the thread was interrupted during the call