Package com.github.jamesnetherton.zulip.client.api.server.request

Class CreateDataExportApiRequest

java.lang.Object

com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

com.github.jamesnetherton.zulip.client.api.server.request.CreateDataExportApiRequest

All Implemented Interfaces:

ExecutableApiRequest<Integer>

public class CreateDataExportApiRequest
extends ZulipApiRequest
implements ExecutableApiRequest<Integer>

Zulip API request builder for creating a data export.

See Also:

• https://zulip.com/api/export-realm

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPORT_TYPE

Constructor Summary

Constructors

Constructor	Description
CreateDataExportApiRequest(ZulipHttpClient client)	Constructs a CreateDataExportApiRequest.

Method Summary

Modifier and Type	Method	Description
Integer	execute()	Executes the Zulip API request for creating a data export.
CreateDataExportApiRequest	withExportType(DataExportType exportType)	Sets the type of the data export.

Methods inherited from class com.github.jamesnetherton.zulip.client.api.core.ZulipApiRequest

client, getParam, getParam, getParams, putParam, putParamAsJsonString, putParamAsWrappedObject

Methods inherited from class java.lang.Object

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

Field Details

EXPORT_TYPE

public static final String EXPORT_TYPE

See Also:

• Constant Field Values

Constructor Details

CreateDataExportApiRequest

public CreateDataExportApiRequest(ZulipHttpClient client)

Constructs a CreateDataExportApiRequest.

Parameters:

client - The Zulip HTTP client

Method Details

withExportType

public CreateDataExportApiRequest withExportType(DataExportType exportType)

Sets the type of the data export.

Parameters:

exportType - The type of data export

Returns:

This CreateDataExportApiRequest instance

execute

public Integer execute()
                throws ZulipClientException

Executes the Zulip API request for creating a data export.

Specified by:

execute in interface ExecutableApiRequest<Integer>

Returns:

The id of the created DataExport

Throws:

ZulipClientException - if the request was not successful