com.microsoft.graph.requests

Class BaseItemCollectionRequest

java.lang.Object

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

com.microsoft.graph.http.BaseEntityCollectionRequest<BaseItem,BaseItemCollectionResponse,BaseItemCollectionPage>

com.microsoft.graph.requests.BaseItemCollectionRequest

All Implemented Interfaces:

com.microsoft.graph.http.IHttpRequest

public class BaseItemCollectionRequest
extends com.microsoft.graph.http.BaseEntityCollectionRequest<BaseItem,BaseItemCollectionResponse,BaseItemCollectionPage>

The class for the Base Item Collection Request.

Field Summary

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

responseCollectionClass

Constructor Summary

Constructors

Constructor and Description
BaseItemCollectionRequest(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 BaseItem

Method Summary

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

BaseItemCollectionRequest

public BaseItemCollectionRequest(@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 BaseItem

Parameters:

requestUrl - the request URL

client - the service client

requestOptions - the options for this request

Method Detail

postAsync

@Nonnull
public java.util.concurrent.CompletableFuture<BaseItem> postAsync(@Nonnull
                                                                            BaseItem newBaseItem)

Creates a new BaseItem

Parameters:

newBaseItem - the BaseItem to create

Returns:

a future with the created object

post

@Nonnull
public BaseItem post(@Nonnull
                               BaseItem newBaseItem)
                        throws com.microsoft.graph.core.ClientException

Creates a new BaseItem

Parameters:

newBaseItem - the BaseItem to create

Returns:

the newly created object

Throws:

com.microsoft.graph.core.ClientException

expand

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

Sets the count value to true for the request

Returns:

the updated request

skip

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

Add Skip token for pagination

Parameters:

skipToken - - Token for pagination

Returns:

the updated request