Package com.microsoft.graph.requests

Class PlannerRequest

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

  • Method Summary

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

    • PlannerRequest

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

  • Method Details

    • getAsync

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

    • get

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

    • delete

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

    • patch

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

    • postAsync

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

    • post

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

    • putAsync

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

    • put

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

    • select

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

    • expand

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