Package com.microsoft.graph.requests

Class ListCollectionRequest

java.lang.Object
com.microsoft.graph.http.BaseCollectionRequest<T,T2,T3>
com.microsoft.graph.http.BaseEntityCollectionRequest<List,ListCollectionResponse,ListCollectionPage>
com.microsoft.graph.requests.ListCollectionRequest
All Implemented Interfaces:
com.microsoft.graph.http.IHttpRequest
public class ListCollectionRequest extends com.microsoft.graph.http.BaseEntityCollectionRequest<List,ListCollectionResponse,ListCollectionPage>
The class for the List Collection Request.

  • Field Summary

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

    responseCollectionClass

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    ListCollectionRequest
    count()
    Sets the count value to true for the request
    ListCollectionRequest
    count(boolean value)
    Sets the count value for the request
    ListCollectionRequest
    expand(String value)
    Sets the expand clause for the request
    ListCollectionRequest
    filter(String value)
    Sets the filter clause for the request
    ListCollectionRequest
    orderBy(String value)
    Sets the order by clause for the request
    List
    post(List newList)
    Creates a new List
    CompletableFuture<List>
    postAsync(List newList)
    Creates a new List
    ListCollectionRequest
    select(String value)
    Sets the select clause for the request
    ListCollectionRequest
    skip(int value)
    Sets the skip value for the request
    ListCollectionRequest
    skipToken(String skipToken)
    Add Skip token for pagination
    ListCollectionRequest
    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

    • ListCollectionRequest

      public ListCollectionRequest(@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 List
      Parameters:
      requestUrl - the request URL
      client - the service client
      requestOptions - the options for this request

  • Method Details

    • postAsync

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

    • post

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

    • expand

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

    • filter

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

    • orderBy

      @Nonnull public ListCollectionRequest 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 ListCollectionRequest select(@Nonnull String value)
      Sets the select clause for the request
      Parameters:
      value - the select clause
      Returns:
      the updated request

    • top

      @Nonnull public ListCollectionRequest 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 ListCollectionRequest 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 ListCollectionRequest count()
      Sets the count value to true for the request
      Returns:
      the updated request

    • skip

      @Nonnull public ListCollectionRequest skip(int value)
      Sets the skip value for the request
      Parameters:
      value - of the number of items to skip
      Returns:
      the updated request

    • skipToken

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