Package com.microsoft.graph.requests

Class BaseItemRequest

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

  • Method Summary

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

    • BaseItemRequest

      public BaseItemRequest(@Nonnull String requestUrl, @Nonnull com.microsoft.graph.core.IBaseClient<?> client, @Nullable List<? extends com.microsoft.graph.options.Option> requestOptions, @Nonnull Class<? extends BaseItem> responseClass)
      The request for the BaseItem
      Parameters:
      requestUrl - the request URL
      client - the service client
      requestOptions - the options for this request
      responseClass - the class of the response

    • BaseItemRequest

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

  • Method Details

    • getAsync

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

    • get

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

    • delete

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

    • patch

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

    • postAsync

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

    • post

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

    • putAsync

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

    • put

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

    • select

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

    • expand

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