Package org.azd.wiki.pages

Class PagesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.wiki.pages.PagesRequestBuilder

public class PagesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Wiki pages Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PagesRequestBuilder.DeleteQueryParameters	Represents the query parameters.
static class	PagesRequestBuilder.DeleteRequestConfiguration	Request configuration object for the query parameters.
static class	PagesRequestBuilder.GetByIdQueryParameters	Represents the query parameters.
static class	PagesRequestBuilder.GetByIdRequestConfiguration	Request configuration object for the query parameters.
static class	PagesRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	PagesRequestBuilder.GetRequestConfiguration	Request configuration object for the query parameters.
static class	PagesRequestBuilder.QueryParameters	Represents the query parameters.
static class	PagesRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
PagesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
WikiPage	createOrUpdate(WikiCreateOrUpdateParameters wikiCreateOrUpdateParameters, Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)	Creates or edits a wiki page.
CompletableFuture<WikiPage>	createOrUpdateAsync(WikiCreateOrUpdateParameters wikiCreateOrUpdateParameters, Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)	Creates or edits a wiki page.
WikiPage	delete(String wikiIdentifier, Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)	Deletes a wiki page.
CompletableFuture<WikiPage>	deleteAsync(String wikiIdentifier, Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)	Deletes a wiki page.
WikiPage	deleteById(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)	Deletes a wiki page.
CompletableFuture<WikiPage>	deleteByIdAsync(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)	Deletes a wiki page.
WikiPage	get(String wikiIdentifier)	Gets metadata of the wiki page for the provided path.
WikiPage	get(String wikiIdentifier, Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets metadata of the wiki page for the provided path.
String	getAsText(String wikiIdentifier, Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets metadata of the wiki page for the provided path.
CompletableFuture<String>	getAsTextAsync(String wikiIdentifier, Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets metadata of the wiki page for the provided path.
CompletableFuture<WikiPage>	getAsync(String wikiIdentifier)	Gets metadata of the wiki page for the provided path.
CompletableFuture<WikiPage>	getAsync(String wikiIdentifier, Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets metadata of the wiki page for the provided path.
InputStream	getAsZip(String wikiIdentifier, Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets metadata of the wiki page for the provided path.
CompletableFuture<InputStream>	getAsZipAsync(String wikiIdentifier, Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)	Gets metadata of the wiki page for the provided path.
WikiPage	getById(String wikiIdentifier, int id)	Gets metadata or content of the wiki page for the provided page id.
WikiPage	getById(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)	Gets metadata or content of the wiki page for the provided page id.
String	getByIdAsText(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)	Gets metadata or content of the wiki page for the provided page id.
CompletableFuture<String>	getByIdAsTextAsync(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)	Gets metadata or content of the wiki page for the provided page id.
CompletableFuture<WikiPage>	getByIdAsync(String wikiIdentifier, int id)	Gets metadata or content of the wiki page for the provided page id.
CompletableFuture<WikiPage>	getByIdAsync(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)	Gets metadata or content of the wiki page for the provided page id.
InputStream	getByIdAsZip(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)	Gets metadata or content of the wiki page for the provided page id.
CompletableFuture<InputStream>	getByIdAsZipAsync(String wikiIdentifier, int id, Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)	Gets metadata or content of the wiki page for the provided page id.
WikiPage	update(WikiUpdateParameters wikiUpdateParameters)	Edits a wiki page.
CompletableFuture<WikiPage>	updateAsync(WikiUpdateParameters wikiUpdateParameters)	Edits a wiki page.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

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

Constructor Details

PagesRequestBuilder

public PagesRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

createOrUpdateAsync

public CompletableFuture<WikiPage> createOrUpdateAsync(WikiCreateOrUpdateParameters wikiCreateOrUpdateParameters,
 Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)
                                                throws AzDException

Creates or edits a wiki page.

Parameters:

wikiCreateOrUpdateParameters - Create or update parameters. eTag is mandatory for Edit scenario.

requestConfiguration - Represents the query parameters. Parameter path is mandatory.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<WikiPage> deleteAsync(String wikiIdentifier,
 Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)
                                        throws AzDException

Deletes a wiki page.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters. Parameter path is mandatory.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

deleteByIdAsync

public CompletableFuture<WikiPage> deleteByIdAsync(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
                                            throws AzDException

Deletes a wiki page.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WikiPage> getAsync(String wikiIdentifier)
                                     throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<WikiPage> getAsync(String wikiIdentifier,
 Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)
                                     throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getAsTextAsync

public CompletableFuture<String> getAsTextAsync(String wikiIdentifier,
 Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)
                                         throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters.

Returns:

The wiki page content.

Throws:

AzDException - Default Api Exception handler.

getAsZipAsync

public CompletableFuture<InputStream> getAsZipAsync(String wikiIdentifier,
 Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)
                                             throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters.

Returns:

The wiki page contents as input stream. Use StreamHelper to download the contents as zip.

Throws:

AzDException - Default Api Exception handler.

getByIdAsync

public CompletableFuture<WikiPage> getByIdAsync(String wikiIdentifier,
 int id)
                                         throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getByIdAsync

public CompletableFuture<WikiPage> getByIdAsync(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)
                                         throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getByIdAsTextAsync

public CompletableFuture<String> getByIdAsTextAsync(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)
                                             throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

Wiki page context.

Throws:

AzDException - Default Api Exception handler.

getByIdAsZipAsync

public CompletableFuture<InputStream> getByIdAsZipAsync(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)
                                                 throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

Wiki page(s) as zip content. Use StreamHelper to download the contents as zip.

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<WikiPage> updateAsync(WikiUpdateParameters wikiUpdateParameters)
                                        throws AzDException

Edits a wiki page.

Parameters:

wikiUpdateParameters - Wiki update parameters to edit the page.

Returns:

Wiki page object WikiPage

Throws:

AzDException - Default Api Exception handler.

createOrUpdate

public WikiPage createOrUpdate(WikiCreateOrUpdateParameters wikiCreateOrUpdateParameters,
 Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)
                        throws AzDException

Creates or edits a wiki page.

Parameters:

wikiCreateOrUpdateParameters - Create or update parameters. eTag is mandatory for Edit scenario.

requestConfiguration - Represents the query parameters. Parameter path is mandatory.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

delete

public WikiPage delete(String wikiIdentifier,
 Consumer<PagesRequestBuilder.RequestConfiguration> requestConfiguration)
                throws AzDException

Deletes a wiki page.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters. Parameter path is mandatory.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

deleteById

public WikiPage deleteById(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
                    throws AzDException

Deletes a wiki page.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

get

public WikiPage get(String wikiIdentifier)
             throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

get

public WikiPage get(String wikiIdentifier,
 Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)
             throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getAsText

public String getAsText(String wikiIdentifier,
 Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)
                 throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters.

Returns:

The wiki page content.

Throws:

AzDException - Default Api Exception handler.

getAsZip

public InputStream getAsZip(String wikiIdentifier,
 Consumer<PagesRequestBuilder.GetRequestConfiguration> requestConfiguration)
                     throws AzDException

Gets metadata of the wiki page for the provided path.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

requestConfiguration - Represents the query parameters.

Returns:

The wiki page contents as input stream. Use StreamHelper to download the contents as zip.

Throws:

AzDException - Default Api Exception handler.

getById

public WikiPage getById(String wikiIdentifier,
 int id)
                 throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getById

public WikiPage getById(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)
                 throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

WikiPage Object WikiPage

Throws:

AzDException - Default Api Exception handler.

getByIdAsText

public String getByIdAsText(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)
                     throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

Wiki page context.

Throws:

AzDException - Default Api Exception handler.

getByIdAsZip

public InputStream getByIdAsZip(String wikiIdentifier,
 int id,
 Consumer<PagesRequestBuilder.GetByIdRequestConfiguration> requestConfiguration)
                         throws AzDException

Gets metadata or content of the wiki page for the provided page id.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

id - Wiki page ID.

requestConfiguration - Represents the query parameters.

Returns:

Wiki page(s) as zip content. Use StreamHelper to download the contents as zip.

Throws:

AzDException - Default Api Exception handler.

update

public WikiPage update(WikiUpdateParameters wikiUpdateParameters)
                throws AzDException

Edits a wiki page.

Parameters:

wikiUpdateParameters - Wiki update parameters to edit the page.

Returns:

Wiki page object WikiPage

Throws:

AzDException - Default Api Exception handler.