com.microsoft.graph.requests

Class ListRequest

java.lang.Object

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

com.microsoft.graph.requests.ListRequest

All Implemented Interfaces:

com.microsoft.graph.http.IHttpRequest

public class ListRequest
extends com.microsoft.graph.http.BaseRequest<List>

The class for the List Request.

Field Summary

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

functionOptions, queryOptions, REQUEST_STATS_HEADER_VALUE_FORMAT_STRING

Constructor Summary

Constructors

Constructor and Description
ListRequest(java.lang.String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, java.util.List<? extends com.microsoft.graph.options.Option> requestOptions) The request for the List

Method Summary

Modifier and Type	Method and Description
List	delete() Delete this item from the service
java.util.concurrent.CompletableFuture<List>	deleteAsync() Delete this item from the service
ListRequest	expand(java.lang.String value) Sets the expand clause for the request
List	get() Gets the List from the service
java.util.concurrent.CompletableFuture<List>	getAsync() Gets the List from the service
List	patch(List sourceList) Patches this List with a source
java.util.concurrent.CompletableFuture<List>	patchAsync(List sourceList) Patches this List with a source
List	post(List newList) Creates a List with a new object
java.util.concurrent.CompletableFuture<List>	postAsync(List newList) Creates a List with a new object
List	put(List newList) Creates a List with a new object
java.util.concurrent.CompletableFuture<List>	putAsync(List newList) Creates a List with a new object
ListRequest	select(java.lang.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 Detail

ListRequest

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

The request for the List

Parameters:

requestUrl - the request URL

client - the service client

requestOptions - the options for this request

Method Detail

getAsync

@Nonnull
public java.util.concurrent.CompletableFuture<List> getAsync()

Gets the List from the service

Returns:

a future with the result

get

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

Gets the List from the service

Returns:

the List 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 java.util.concurrent.CompletableFuture<List> deleteAsync()

Delete this item from the service

Returns:

a future with the deletion result

delete

@Nullable
public List 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 java.util.concurrent.CompletableFuture<List> patchAsync(@Nonnull
                                                                         List sourceList)

Patches this List with a source

Parameters:

sourceList - the source object with updates

Returns:

a future with the result

patch

@Nullable
public List patch(@Nonnull
                             List sourceList)
                      throws com.microsoft.graph.core.ClientException

Patches this List with a source

Parameters:

sourceList - the source object with updates

Returns:

the updated List

Throws:

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

postAsync

@Nonnull
public java.util.concurrent.CompletableFuture<List> postAsync(@Nonnull
                                                                        List newList)

Creates a List with a new object

Parameters:

newList - the new object to create

Returns:

a future with the result

post

@Nullable
public List post(@Nonnull
                            List newList)
                     throws com.microsoft.graph.core.ClientException

Creates a List with a new object

Parameters:

newList - the new object to create

Returns:

the created List

Throws:

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

putAsync

@Nonnull
public java.util.concurrent.CompletableFuture<List> putAsync(@Nonnull
                                                                       List newList)

Creates a List with a new object

Parameters:

newList - the object to create/update

Returns:

a future with the result

put

@Nullable
public List put(@Nonnull
                           List newList)
                    throws com.microsoft.graph.core.ClientException

Creates a List with a new object

Parameters:

newList - the object to create/update

Returns:

the created List

Throws:

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

select

@Nonnull
public ListRequest select(@Nonnull
                                    java.lang.String value)

Sets the select clause for the request

Parameters:

value - the select clause

Returns:

the updated request

expand

@Nonnull
public ListRequest expand(@Nonnull
                                    java.lang.String value)

Sets the expand clause for the request

Parameters:

value - the expand clause

Returns:

the updated request