Package com.ngrok.services

Class AbuseReports.CreateCallBuilder

java.lang.Object

com.ngrok.services.AbuseReports.CreateCallBuilder

Enclosing class:

AbuseReports

public class AbuseReports.CreateCallBuilder
extends Object

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

Method Summary

Modifier and Type	Method	Description
AbuseReport	blockingCall()	Initiates the API call and blocks until it returns.
CompletionStage<AbuseReport>	call()	Initiates the API call asynchronously.
AbuseReports.CreateCallBuilder	metadata(String metadata)	arbitrary user-defined data about this abuse report.
AbuseReports.CreateCallBuilder	metadata(Optional<String> metadata)	arbitrary user-defined data about this abuse report.

Methods inherited from class java.lang.Object

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

Method Details

metadata

public AbuseReports.CreateCallBuilder metadata(String metadata)

arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.

Parameters:

metadata - the value of the metadata parameter as a String

Returns:

the call builder instance

metadata

public AbuseReports.CreateCallBuilder metadata(Optional<String> metadata)

arbitrary user-defined data about this abuse report. 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<AbuseReport> call()

Initiates the API call asynchronously.

Returns:

a CompletionStage of AbuseReport

blockingCall

public AbuseReport blockingCall()
                         throws InterruptedException

Initiates the API call and blocks until it returns.

Returns:

AbuseReport

Throws:

InterruptedException - if the thread was interrupted during the call