com.microsoft.graph.requests

Class PersonCollectionRequest

java.lang.Object

com.microsoft.graph.http.BaseCollectionRequest<T,T2,T3>

com.microsoft.graph.http.BaseEntityCollectionRequest<Person,PersonCollectionResponse,PersonCollectionPage>

com.microsoft.graph.requests.PersonCollectionRequest

All Implemented Interfaces:

com.microsoft.graph.http.IHttpRequest

public class PersonCollectionRequest
extends com.microsoft.graph.http.BaseEntityCollectionRequest<Person,PersonCollectionResponse,PersonCollectionPage>

The class for the Person Collection Request.

Field Summary

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

responseCollectionClass

Constructor Summary

Constructors

Constructor and Description
PersonCollectionRequest(java.lang.String requestUrl, com.microsoft.graph.core.IBaseClient<?> client, java.util.List<? extends com.microsoft.graph.options.Option> requestOptions) The request builder for this collection of Person

Method Summary

Modifier and Type	Method and Description
PersonCollectionRequest	count() Sets the count value to true for the request
PersonCollectionRequest	count(boolean value) Sets the count value for the request
PersonCollectionRequest	expand(java.lang.String value) Sets the expand clause for the request
PersonCollectionRequest	filter(java.lang.String value) Sets the filter clause for the request
PersonCollectionRequest	orderBy(java.lang.String value) Sets the order by clause for the request
Person	post(Person newPerson) Creates a new Person
java.util.concurrent.CompletableFuture<Person>	postAsync(Person newPerson) Creates a new Person
PersonCollectionRequest	select(java.lang.String value) Sets the select clause for the request
PersonCollectionRequest	skip(int value) Sets the skip value for the request
PersonCollectionRequest	skipToken(java.lang.String skipToken) Add Skip token for pagination
PersonCollectionRequest	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 Detail

PersonCollectionRequest

public PersonCollectionRequest(@Nonnull
                               java.lang.String requestUrl,
                               @Nonnull
                               com.microsoft.graph.core.IBaseClient<?> client,
                               @Nullable
                               java.util.List<? extends com.microsoft.graph.options.Option> requestOptions)

The request builder for this collection of Person

Parameters:

requestUrl - the request URL

client - the service client

requestOptions - the options for this request

Method Detail

postAsync

@Nonnull
public java.util.concurrent.CompletableFuture<Person> postAsync(@Nonnull
                                                                          Person newPerson)

Creates a new Person

Parameters:

newPerson - the Person to create

Returns:

a future with the created object

post

@Nonnull
public Person post(@Nonnull
                             Person newPerson)
                      throws com.microsoft.graph.core.ClientException

Creates a new Person

Parameters:

newPerson - the Person to create

Returns:

the newly created object

Throws:

com.microsoft.graph.core.ClientException

expand

@Nonnull
public PersonCollectionRequest expand(@Nonnull
                                                java.lang.String value)

Sets the expand clause for the request

Parameters:

value - the expand clause

Returns:

the updated request

filter

@Nonnull
public PersonCollectionRequest filter(@Nonnull
                                                java.lang.String value)

Sets the filter clause for the request

Parameters:

value - the filter clause

Returns:

the updated request

orderBy

@Nonnull
public PersonCollectionRequest orderBy(@Nonnull
                                                 java.lang.String value)

Sets the order by clause for the request

Parameters:

value - the order by clause

Returns:

the updated request

select

@Nonnull
public PersonCollectionRequest select(@Nonnull
                                                java.lang.String value)

Sets the select clause for the request

Parameters:

value - the select clause

Returns:

the updated request

top

@Nonnull
public PersonCollectionRequest 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 PersonCollectionRequest 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 PersonCollectionRequest count()

Sets the count value to true for the request

Returns:

the updated request

skip

@Nonnull
public PersonCollectionRequest 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 PersonCollectionRequest skipToken(@Nonnull
                                                   java.lang.String skipToken)

Add Skip token for pagination

Parameters:

skipToken - - Token for pagination

Returns:

the updated request