Package com.microsoft.graph.requests

Class UserCollectionRequest

java.lang.Object
com.microsoft.graph.http.BaseCollectionRequest<T,T2,T3>
com.microsoft.graph.http.BaseEntityCollectionRequest<User,UserCollectionResponse,UserCollectionPage>
com.microsoft.graph.requests.UserCollectionRequest
All Implemented Interfaces:
com.microsoft.graph.http.IHttpRequest
public class UserCollectionRequest extends com.microsoft.graph.http.BaseEntityCollectionRequest<User,UserCollectionResponse,UserCollectionPage>
The class for the User Collection Request.

  • Field Summary

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

    responseCollectionClass

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserCollectionRequest(String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, List<? extends com.microsoft.graph.options.Option> requestOptions)
    The request builder for this collection of User

  • Method Summary

    Modifier and Type
    Method
    Description
    UserCollectionRequest
    count()
    Sets the count value to true for the request
    UserCollectionRequest
    count(boolean value)
    Sets the count value for the request
    UserCollectionRequest
    expand(String value)
    Sets the expand clause for the request
    UserCollectionRequest
    filter(String value)
    Sets the filter clause for the request
    UserCollectionRequest
    orderBy(String value)
    Sets the order by clause for the request
    User
    post(User newUser)
    Creates a new User
    CompletableFuture<User>
    postAsync(User newUser)
    Creates a new User
    UserCollectionRequest
    select(String value)
    Sets the select clause for the request
    UserCollectionRequest
    skipToken(String skipToken)
    Add Skip token for pagination
    UserCollectionRequest
    top(int value)
    Sets the top value for the request

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

    get, getAsync, post

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

    addCountOption, addExpandOption, addFilterOption, addFunctionOption, addHeader, addOrderByOption, addQueryOption, addSelectOption, addSkipOption, addSkipTokenOption, addTopOption, buildFromResponse, getBaseRequest, getCollectionPageClass, getDelay, getHeaders, getHttpMethod, getHttpRequest, getMaxRedirects, getMaxRetries, getOptions, getRequestUrl, getShouldRedirect, getShouldRetry, getUseCaches, send, sendAsync, setDelay, 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

    • UserCollectionRequest

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

  • Method Details

    • postAsync

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

    • post

      @Nonnull public User post(@Nonnull User newUser) throws com.microsoft.graph.core.ClientException
      Creates a new User
      Parameters:
      newUser - the User to create
      Returns:
      the newly created object
      Throws:
      com.microsoft.graph.core.ClientException

    • expand

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

    • filter

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

    • orderBy

      @Nonnull public UserCollectionRequest orderBy(@Nonnull String value)
      Sets the order by clause for the request
      Parameters:
      value - the order by clause
      Returns:
      the updated request

    • select

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

    • top

      @Nonnull public UserCollectionRequest top(int value)
      Sets the top value for the request
      Parameters:
      value - the max number of items to return
      Returns:
      the updated request

    • count

      @Nonnull public UserCollectionRequest count(boolean value)
      Sets the count value for the request
      Parameters:
      value - whether or not to return the count of objects with the request
      Returns:
      the updated request

    • count

      @Nonnull public UserCollectionRequest count()
      Sets the count value to true for the request
      Returns:
      the updated request

    • skipToken

      @Nonnull public UserCollectionRequest skipToken(@Nonnull String skipToken)
      Add Skip token for pagination
      Parameters:
      skipToken - - Token for pagination
      Returns:
      the updated request