Package com.microsoft.graph.requests

Class UserRequest

java.lang.Object
com.microsoft.graph.http.BaseRequest<User>
com.microsoft.graph.requests.UserRequest
All Implemented Interfaces:
com.microsoft.graph.http.IHttpRequest
public class UserRequest extends com.microsoft.graph.http.BaseRequest<User>
The class for the User 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
    UserRequest(String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, List<? extends com.microsoft.graph.options.Option> requestOptions)
    The request for the User

  • Method Summary

    Modifier and Type
    Method
    Description
    User
    delete()
    Delete this item from the service
    CompletableFuture<User>
    deleteAsync()
    Delete this item from the service
    UserRequest
    expand(String value)
    Sets the expand clause for the request
    User
    get()
    Gets the User from the service
    CompletableFuture<User>
    getAsync()
    Gets the User from the service
    User
    patch(User sourceUser)
    Patches this User with a source
    CompletableFuture<User>
    patchAsync(User sourceUser)
    Patches this User with a source
    User
    post(User newUser)
    Creates a User with a new object
    CompletableFuture<User>
    postAsync(User newUser)
    Creates a User with a new object
    User
    put(User newUser)
    Creates a User with a new object
    CompletableFuture<User>
    putAsync(User newUser)
    Creates a User with a new object
    UserRequest
    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

    • UserRequest

      public UserRequest(@Nonnull String requestUrl, @Nonnull com.microsoft.graph.core.IBaseClient<?> client, @Nullable List<? extends com.microsoft.graph.options.Option> requestOptions)
      The request for the User
      Parameters:
      requestUrl - the request URL
      client - the service client
      requestOptions - the options for this request

  • Method Details

    • getAsync

      @Nonnull public CompletableFuture<User> getAsync()
      Gets the User from the service
      Returns:
      a future with the result

    • get

      @Nullable public User get() throws com.microsoft.graph.core.ClientException
      Gets the User from the service
      Returns:
      the User 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<User> deleteAsync()
      Delete this item from the service
      Returns:
      a future with the deletion result

    • delete

      @Nullable public User 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<User> patchAsync(@Nonnull User sourceUser)
      Patches this User with a source
      Parameters:
      sourceUser - the source object with updates
      Returns:
      a future with the result

    • patch

      @Nullable public User patch(@Nonnull User sourceUser) throws com.microsoft.graph.core.ClientException
      Patches this User with a source
      Parameters:
      sourceUser - the source object with updates
      Returns:
      the updated User
      Throws:
      com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

    • postAsync

      @Nonnull public CompletableFuture<User> postAsync(@Nonnull User newUser)
      Creates a User with a new object
      Parameters:
      newUser - the new object to create
      Returns:
      a future with the result

    • post

      @Nullable public User post(@Nonnull User newUser) throws com.microsoft.graph.core.ClientException
      Creates a User with a new object
      Parameters:
      newUser - the new object to create
      Returns:
      the created User
      Throws:
      com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

    • putAsync

      @Nonnull public CompletableFuture<User> putAsync(@Nonnull User newUser)
      Creates a User with a new object
      Parameters:
      newUser - the object to create/update
      Returns:
      a future with the result

    • put

      @Nullable public User put(@Nonnull User newUser) throws com.microsoft.graph.core.ClientException
      Creates a User with a new object
      Parameters:
      newUser - the object to create/update
      Returns:
      the created User
      Throws:
      com.microsoft.graph.core.ClientException - this exception occurs if the request was unable to complete for any reason

    • select

      @Nonnull public UserRequest select(@Nonnull String value)
      Sets the select clause for the request
      Parameters:
      value - the select clause
      Returns:
      the updated request

    • expand

      @Nonnull public UserRequest expand(@Nonnull String value)
      Sets the expand clause for the request
      Parameters:
      value - the expand clause
      Returns:
      the updated request