Package org.azd.wiki.wikis

Class WikisRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.wiki.wikis.WikisRequestBuilder

public class WikisRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Wiki wikis Api.

Nested Class Summary

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
WikisRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
WikiV2	create(WikiCreateParameters wikiCreateParameters)	Creates the wiki resource.
CompletableFuture<WikiV2>	createAsync(WikiCreateParameters wikiCreateParameters)	Creates the wiki resource.
WikiV2	delete(String wikiIdentifier)	Deletes the wiki corresponding to the wiki ID or wiki name provided.
CompletableFuture<WikiV2>	deleteAsync(String wikiIdentifier)	Deletes the wiki corresponding to the wiki ID or wiki name provided.
WikiV2	get(String wikiIdentifier)	Gets the wiki corresponding to the wiki ID or wiki name provided.
CompletableFuture<WikiV2>	getAsync(String wikiIdentifier)	Gets the wiki corresponding to the wiki ID or wiki name provided.
WikiV2Pages	list()	Gets all wikis in a project or collection.
CompletableFuture<WikiV2Pages>	listAsync()	Gets all wikis in a project or collection.
WikiV2	update(String wikiIdentifier, WikiV2UpdateParameters wikiV2UpdateParameters)	Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters.
CompletableFuture<WikiV2>	updateAsync(String wikiIdentifier, WikiV2UpdateParameters wikiV2UpdateParameters)	Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters.

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

WikisRequestBuilder

public WikisRequestBuilder(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

createAsync

public CompletableFuture<WikiV2> createAsync(WikiCreateParameters wikiCreateParameters)
                                      throws AzDException

Creates the wiki resource.

Parameters:

wikiCreateParameters - WikiCreateParameters helps to create code wiki and project wiki. Use the constructor parameter to create respective wikis.

Returns:

WikiV2 object WikiV2

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<WikiV2> deleteAsync(String wikiIdentifier)
                                      throws AzDException

Deletes the wiki corresponding to the wiki ID or wiki name provided.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

Returns:

WikiV2 WikiV2

Throws:

AzDException - Default Api Exception handler.

getAsync

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

Gets the wiki corresponding to the wiki ID or wiki name provided.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

Returns:

WikiV2 WikiV2

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<WikiV2Pages> listAsync()
                                         throws AzDException

Gets all wikis in a project or collection.

Returns:

WikiV2s WikiV2Pages

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<WikiV2> updateAsync(String wikiIdentifier,
 WikiV2UpdateParameters wikiV2UpdateParameters)
                                      throws AzDException

Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

wikiV2UpdateParameters - Wiki update parameters object.

Returns:

WikiV2 WikiV2

Throws:

AzDException - Default Api Exception handler.

create

public WikiV2 create(WikiCreateParameters wikiCreateParameters)
              throws AzDException

Creates the wiki resource.

Parameters:

wikiCreateParameters - WikiCreateParameters helps to create code wiki and project wiki. Use the constructor parameter to create respective wikis.

Returns:

WikiV2 object WikiV2

Throws:

AzDException - Default Api Exception handler.

delete

public WikiV2 delete(String wikiIdentifier)
              throws AzDException

Deletes the wiki corresponding to the wiki ID or wiki name provided.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

Returns:

WikiV2 WikiV2

Throws:

AzDException - Default Api Exception handler.

get

public WikiV2 get(String wikiIdentifier)
           throws AzDException

Gets the wiki corresponding to the wiki ID or wiki name provided.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

Returns:

WikiV2 WikiV2

Throws:

AzDException - Default Api Exception handler.

list

public WikiV2Pages list()
                 throws AzDException

Gets all wikis in a project or collection.

Returns:

WikiV2s WikiV2Pages

Throws:

AzDException - Default Api Exception handler.

update

public WikiV2 update(String wikiIdentifier,
 WikiV2UpdateParameters wikiV2UpdateParameters)
              throws AzDException

Updates the wiki corresponding to the wiki ID or wiki name provided using the update parameters.

Parameters:

wikiIdentifier - Wiki ID or wiki name.

wikiV2UpdateParameters - Wiki update parameters object.

Returns:

WikiV2 WikiV2

Throws:

AzDException - Default Api Exception handler.