Class SearchRequest

java.lang.Object
com.microsoft.graph.http.BaseRequest<Search>
com.microsoft.graph.security.requests.SearchRequest
All Implemented Interfaces:
com.microsoft.graph.http.IHttpRequest

public class SearchRequest extends com.microsoft.graph.http.BaseRequest<Search>
The class for the Search 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
    SearchRequest(String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, List<? extends com.microsoft.graph.options.Option> requestOptions)
    The request for the Search
    SearchRequest(String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, List<? extends com.microsoft.graph.options.Option> requestOptions, Class<? extends Search> responseClass)
    The request for the Search
  • Method Summary

    Modifier and Type
    Method
    Description
    Delete this item from the service
    Delete this item from the service
    expand(String value)
    Sets the expand clause for the request
    get()
    Gets the Search from the service
    Gets the Search from the service
    patch(Search sourceSearch)
    Patches this Search with a source
    patchAsync(Search sourceSearch)
    Patches this Search with a source
    post(Search newSearch)
    Creates a Search with a new object
    postAsync(Search newSearch)
    Creates a Search with a new object
    put(Search newSearch)
    Creates a Search with a new object
    putAsync(Search newSearch)
    Creates a Search with a new object
    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

    • SearchRequest

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

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

    • getAsync

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

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

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

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

      @Nonnull public CompletableFuture<Search> postAsync(@Nonnull Search newSearch)
      Creates a Search with a new object
      Parameters:
      newSearch - the new object to create
      Returns:
      a future with the result
    • post

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

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

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

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

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