Package com.microsoft.graph.requests

Class PayloadRequest

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

  • Method Summary

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

    • PayloadRequest

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

  • Method Details

    • getAsync

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

    • get

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

    • delete

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

    • patch

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

    • postAsync

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

    • post

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

    • putAsync

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

    • put

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

    • select

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

    • expand

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