Package com.microsoft.graph.requests

Class DirectoryObjectRequest

java.lang.Object

com.microsoft.graph.http.BaseRequest<DirectoryObject>

com.microsoft.graph.requests.DirectoryObjectRequest

All Implemented Interfaces:

com.microsoft.graph.http.IHttpRequest

public class DirectoryObjectRequest
extends com.microsoft.graph.http.BaseRequest<DirectoryObject>

The class for the Directory Object Request.

Field Summary

Fields inherited from class com.microsoft.graph.http.BaseRequest

functionOptions, queryOptions, REQUEST_STATS_HEADER_VALUE_FORMAT_STRING

Constructor Summary

Constructors

Constructor	Description
DirectoryObjectRequest(String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, List<? extends com.microsoft.graph.options.Option> requestOptions)	The request for the DirectoryObject
DirectoryObjectRequest(String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, List<? extends com.microsoft.graph.options.Option> requestOptions, Class<? extends DirectoryObject> responseClass)	The request for the DirectoryObject

Method Summary

Modifier and Type	Method	Description
DirectoryObject	delete()	Delete this item from the service
CompletableFuture<DirectoryObject>	deleteAsync()	Delete this item from the service
DirectoryObjectRequest	expand(String value)	Sets the expand clause for the request
DirectoryObject	get()	Gets the DirectoryObject from the service
CompletableFuture<DirectoryObject>	getAsync()	Gets the DirectoryObject from the service
DirectoryObject	patch(DirectoryObject sourceDirectoryObject)	Patches this DirectoryObject with a source
CompletableFuture<DirectoryObject>	patchAsync(DirectoryObject sourceDirectoryObject)	Patches this DirectoryObject with a source
DirectoryObject	post(DirectoryObject newDirectoryObject)	Creates a DirectoryObject with a new object
CompletableFuture<DirectoryObject>	postAsync(DirectoryObject newDirectoryObject)	Creates a DirectoryObject with a new object
DirectoryObject	put(DirectoryObject newDirectoryObject)	Creates a DirectoryObject with a new object
CompletableFuture<DirectoryObject>	putAsync(DirectoryObject newDirectoryObject)	Creates a DirectoryObject with a new object
DirectoryObjectRequest	select(String value)	Sets the select clause for the request

Methods inherited from class com.microsoft.graph.http.BaseRequest

addCountOption, addExpandOption, addFilterOption, addFunctionOption, addHeader, addOrderByOption, addQueryOption, addSelectOption, addSkipOption, addSkipTokenOption, addTopOption, getClient, getDelay, getFunctionOptions, getHeaders, getHttpMethod, getHttpRequest, getMaxRedirects, getMaxRetries, getOptions, getQueryOptions, getRequestUrl, getResponseType, getShouldRedirect, getShouldRetry, getUseCaches, send, sendAsync, setDelay, setHttpMethod, setMaxRedirects, setMaxRetries, setShouldRedirect, setShouldRetry, setUseCaches, withHttpMethod

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.graph.http.IHttpRequest

getHttpRequest

Constructor Details

DirectoryObjectRequest

public DirectoryObjectRequest(@Nonnull
 String requestUrl,
 @Nonnull
 com.microsoft.graph.core.IBaseClient<?> client,
 @Nullable
 List<? extends com.microsoft.graph.options.Option> requestOptions,
 @Nonnull
 Class<? extends DirectoryObject> responseClass)

The request for the DirectoryObject

Parameters:

requestUrl - the request URL

client - the service client

requestOptions - the options for this request

responseClass - the class of the response

DirectoryObjectRequest

public DirectoryObjectRequest(@Nonnull
 String requestUrl,
 @Nonnull
 com.microsoft.graph.core.IBaseClient<?> client,
 @Nullable
 List<? extends com.microsoft.graph.options.Option> requestOptions)

The request for the DirectoryObject

Parameters:

requestUrl - the request URL

client - the service client

requestOptions - the options for this request

Method Details

getAsync

@Nonnull
public CompletableFuture<DirectoryObject> getAsync()

Gets the DirectoryObject from the service

Returns:

a future with the result

get

@Nullable
public DirectoryObject get()
                    throws com.microsoft.graph.core.ClientException

Gets the DirectoryObject from the service

Returns:

the DirectoryObject from the request

Throws:

com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

deleteAsync

@Nonnull
public CompletableFuture<DirectoryObject> deleteAsync()

Delete this item from the service

Returns:

a future with the deletion result

delete

@Nullable
public DirectoryObject delete()
                       throws com.microsoft.graph.core.ClientException

Delete this item from the service

Returns:

the resulting response if the service returns anything on deletion

Throws:

com.microsoft.graph.core.ClientException - if there was an exception during the delete operation

patchAsync

@Nonnull
public CompletableFuture<DirectoryObject> patchAsync(@Nonnull
 DirectoryObject sourceDirectoryObject)

Patches this DirectoryObject with a source

Parameters:

sourceDirectoryObject - the source object with updates

Returns:

a future with the result

patch

@Nullable
public DirectoryObject patch(@Nonnull
 DirectoryObject sourceDirectoryObject)
                      throws com.microsoft.graph.core.ClientException

Patches this DirectoryObject with a source

Parameters:

sourceDirectoryObject - the source object with updates

Returns:

the updated DirectoryObject

Throws:

com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

postAsync

@Nonnull
public CompletableFuture<DirectoryObject> postAsync(@Nonnull
 DirectoryObject newDirectoryObject)

Creates a DirectoryObject with a new object

Parameters:

newDirectoryObject - the new object to create

Returns:

a future with the result

post

@Nullable
public DirectoryObject post(@Nonnull
 DirectoryObject newDirectoryObject)
                     throws com.microsoft.graph.core.ClientException

Creates a DirectoryObject with a new object

Parameters:

newDirectoryObject - the new object to create

Returns:

the created DirectoryObject

Throws:

com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

putAsync

@Nonnull
public CompletableFuture<DirectoryObject> putAsync(@Nonnull
 DirectoryObject newDirectoryObject)

Creates a DirectoryObject with a new object

Parameters:

newDirectoryObject - the object to create/update

Returns:

a future with the result

put

@Nullable
public DirectoryObject put(@Nonnull
 DirectoryObject newDirectoryObject)
                    throws com.microsoft.graph.core.ClientException

Creates a DirectoryObject with a new object

Parameters:

newDirectoryObject - the object to create/update

Returns:

the created DirectoryObject

Throws:

com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

select

@Nonnull
public DirectoryObjectRequest select(@Nonnull
 String value)

Sets the select clause for the request

Parameters:

value - the select clause

Returns:

the updated request

expand

@Nonnull
public DirectoryObjectRequest expand(@Nonnull
 String value)

Sets the expand clause for the request

Parameters:

value - the expand clause

Returns:

the updated request