com.microsoft.graph.http

Class BaseCollectionRequest<T1,T2>

java.lang.Object

com.microsoft.graph.http.BaseCollectionRequest<T1,T2>

Type Parameters:

T1 - the raw response class returned by the service

T2 - the class of the collection page

All Implemented Interfaces:

IHttpRequest

Direct Known Subclasses:

ActivityBasedTimeoutPolicyCollectionRequest, ActivityHistoryItemCollectionRequest, AdministrativeUnitCollectionRequest, AdministrativeUnitDeltaCollectionRequest, AlertCollectionRequest, AndroidManagedAppProtectionCollectionRequest, ApplicationCollectionReferenceRequest, ApplicationCollectionRequest, ApplicationCollectionWithReferencesRequest, ApplicationDeltaCollectionRequest, AppRoleAssignmentCollectionReferenceRequest, AppRoleAssignmentCollectionRequest, AppRoleAssignmentCollectionWithReferencesRequest, AttachmentCollectionRequest, BaseItemCollectionRequest, CalendarAllowedCalendarSharingRolesCollectionRequest, CalendarCollectionRequest, CalendarGetScheduleCollectionRequest, CalendarGroupCollectionRequest, CalendarPermissionCollectionRequest, CallCollectionRequest, CallRecordCollectionRequest, CertificateBasedAuthConfigurationCollectionReferenceRequest, CertificateBasedAuthConfigurationCollectionRequest, CertificateBasedAuthConfigurationCollectionWithReferencesRequest, ChannelCollectionRequest, ChatCollectionRequest, ChatGetAllMessagesCollectionRequest, ChatMessageCollectionRequest, ChatMessageHostedContentCollectionRequest, ClaimsMappingPolicyCollectionReferenceRequest, ClaimsMappingPolicyCollectionRequest, ClaimsMappingPolicyCollectionWithReferencesRequest, CloudCommunicationsGetPresencesByUserIdCollectionRequest, ColumnDefinitionCollectionRequest, ColumnLinkCollectionRequest, CommsOperationCollectionRequest, ComplianceManagementPartnerCollectionRequest, ConditionalAccessPolicyCollectionRequest, ContactCollectionRequest, ContactDeltaCollectionRequest, ContactFolderCollectionRequest, ContactFolderDeltaCollectionRequest, ContentTypeCollectionRequest, ContractCollectionRequest, ConversationCollectionRequest, ConversationMemberCollectionRequest, ConversationThreadCollectionRequest, DataPolicyOperationCollectionRequest, DefaultManagedAppProtectionCollectionRequest, DelegatedPermissionClassificationCollectionRequest, DetectedAppCollectionRequest, DeviceAndAppManagementRoleAssignmentCollectionRequest, DeviceCategoryCollectionRequest, DeviceCollectionReferenceRequest, DeviceCollectionRequest, DeviceCollectionWithReferencesRequest, DeviceComplianceActionItemCollectionRequest, DeviceComplianceDeviceStatusCollectionRequest, DeviceCompliancePolicyAssignCollectionRequest, DeviceCompliancePolicyAssignmentCollectionRequest, DeviceCompliancePolicyCollectionRequest, DeviceCompliancePolicySettingStateSummaryCollectionRequest, DeviceCompliancePolicyStateCollectionRequest, DeviceComplianceScheduledActionForRuleCollectionRequest, DeviceComplianceSettingStateCollectionRequest, DeviceComplianceUserStatusCollectionRequest, DeviceConfigurationAssignCollectionRequest, DeviceConfigurationAssignmentCollectionRequest, DeviceConfigurationCollectionRequest, DeviceConfigurationDeviceStatusCollectionRequest, DeviceConfigurationStateCollectionRequest, DeviceConfigurationUserStatusCollectionRequest, DeviceEnrollmentConfigurationCollectionRequest, DeviceInstallStateCollectionRequest, DeviceManagementExchangeConnectorCollectionRequest, DeviceManagementGetEffectivePermissionsCollectionRequest, DeviceManagementPartnerCollectionRequest, DeviceManagementTroubleshootingEventCollectionRequest, DirectoryAuditCollectionRequest, DirectoryObjectCheckMemberGroupsCollectionRequest, DirectoryObjectCheckMemberObjectsCollectionRequest, DirectoryObjectCollectionReferenceRequest, DirectoryObjectCollectionRequest, DirectoryObjectCollectionWithReferencesRequest, DirectoryObjectGetAvailableExtensionPropertiesCollectionRequest, DirectoryObjectGetByIdsCollectionRequest, DirectoryObjectGetMemberGroupsCollectionRequest, DirectoryObjectGetMemberObjectsCollectionRequest, DirectoryRoleCollectionRequest, DirectoryRoleDeltaCollectionRequest, DirectoryRoleTemplateCollectionRequest, DomainCollectionRequest, DomainDnsRecordCollectionRequest, DriveCollectionRequest, DriveItemCollectionRequest, DriveItemDeltaCollectionRequest, DriveItemGetActivitiesByIntervalCollectionRequest, DriveItemInviteCollectionRequest, DriveItemSearchCollectionRequest, DriveItemVersionCollectionRequest, DriveRecentCollectionRequest, DriveSearchCollectionRequest, DriveSharedWithMeCollectionRequest, EducationClassCollectionReferenceRequest, EducationClassCollectionRequest, EducationClassCollectionWithReferencesRequest, EducationSchoolCollectionReferenceRequest, EducationSchoolCollectionRequest, EducationSchoolCollectionWithReferencesRequest, EducationUserCollectionReferenceRequest, EducationUserCollectionRequest, EducationUserCollectionWithReferencesRequest, EndpointCollectionReferenceRequest, EndpointCollectionRequest, EndpointCollectionWithReferencesRequest, EnrollmentConfigurationAssignmentCollectionRequest, EventCollectionRequest, EventDeltaCollectionRequest, ExtensionCollectionRequest, ExtensionPropertyCollectionRequest, GroupCheckGrantedPermissionsForAppCollectionRequest, GroupCollectionReferenceRequest, GroupCollectionRequest, GroupCollectionWithReferencesRequest, GroupDeltaCollectionRequest, GroupLifecyclePolicyCollectionRequest, GroupSettingCollectionRequest, GroupSettingTemplateCollectionRequest, HomeRealmDiscoveryPolicyCollectionReferenceRequest, HomeRealmDiscoveryPolicyCollectionRequest, HomeRealmDiscoveryPolicyCollectionWithReferencesRequest, IdentityProviderCollectionRequest, InferenceClassificationOverrideCollectionRequest, InvitationCollectionRequest, IosManagedAppProtectionCollectionRequest, IosUpdateDeviceStatusCollectionRequest, ItemActivityCollectionRequest, ItemActivityStatCollectionRequest, LicenseDetailsCollectionRequest, LinkedResourceCollectionRequest, ListCollectionRequest, ListItemCollectionRequest, ListItemGetActivitiesByIntervalCollectionRequest, ListItemVersionCollectionRequest, LocalizedNotificationMessageCollectionRequest, MailFolderCollectionRequest, MailFolderDeltaCollectionRequest, ManagedAppOperationCollectionRequest, ManagedAppPolicyCollectionRequest, ManagedAppRegistrationCollectionReferenceRequest, ManagedAppRegistrationCollectionRequest, ManagedAppRegistrationCollectionWithReferencesRequest, ManagedAppRegistrationGetUserIdsWithFlaggedAppRegistrationCollectionRequest, ManagedAppStatusCollectionRequest, ManagedDeviceCollectionReferenceRequest, ManagedDeviceCollectionRequest, ManagedDeviceCollectionWithReferencesRequest, ManagedDeviceMobileAppConfigurationAssignmentCollectionRequest, ManagedDeviceMobileAppConfigurationCollectionRequest, ManagedDeviceMobileAppConfigurationDeviceStatusCollectionRequest, ManagedDeviceMobileAppConfigurationUserStatusCollectionRequest, ManagedEBookAssignmentCollectionRequest, ManagedEBookCollectionRequest, ManagedMobileAppCollectionRequest, ManagedMobileLobAppCollectionRequest, MdmWindowsInformationProtectionPolicyCollectionRequest, MessageCollectionRequest, MessageDeltaCollectionRequest, MessageRuleCollectionRequest, MobileAppAssignmentCollectionRequest, MobileAppCategoryCollectionReferenceRequest, MobileAppCategoryCollectionRequest, MobileAppCategoryCollectionWithReferencesRequest, MobileAppCollectionRequest, MobileAppContentCollectionRequest, MobileAppContentFileCollectionRequest, MobileLobAppCollectionRequest, MobileThreatDefenseConnectorCollectionRequest, MultiValueLegacyExtendedPropertyCollectionRequest, NamedLocationCollectionRequest, NotebookCollectionRequest, NotebookGetRecentNotebooksCollectionRequest, NotificationMessageTemplateCollectionRequest, OAuth2PermissionGrantCollectionReferenceRequest, OAuth2PermissionGrantCollectionRequest, OAuth2PermissionGrantCollectionWithReferencesRequest, OAuth2PermissionGrantDeltaCollectionRequest, OfferShiftRequestCollectionRequest, OnenoteOperationCollectionRequest, OnenotePageCollectionRequest, OnenoteResourceCollectionRequest, OnenoteSectionCollectionRequest, OnlineMeetingCollectionRequest, OpenShiftChangeRequestCollectionRequest, OpenShiftCollectionRequest, OrganizationCollectionRequest, OrgContactCollectionReferenceRequest, OrgContactCollectionRequest, OrgContactCollectionWithReferencesRequest, OrgContactDeltaCollectionRequest, OutlookCategoryCollectionRequest, OutlookUserSupportedLanguagesCollectionRequest, OutlookUserSupportedTimeZonesCollectionRequest, ParticipantCollectionRequest, PermissionCollectionRequest, PermissionGrantCollectionRequest, PermissionGrantConditionSetCollectionRequest, PermissionGrantPolicyCollectionRequest, PersonCollectionRequest, PlaceCollectionRequest, PlannerBucketCollectionRequest, PlannerPlanCollectionRequest, PlannerTaskCollectionRequest, PostCollectionRequest, PresenceCollectionRequest, ProfilePhotoCollectionRequest, RemoteAssistancePartnerCollectionRequest, ResourceOperationCollectionRequest, ResourceSpecificPermissionGrantCollectionRequest, RestrictedSignInCollectionRequest, RoleAssignmentCollectionRequest, RoleDefinitionCollectionRequest, RoomCollectionRequest, SchedulingGroupCollectionRequest, SchemaExtensionCollectionRequest, ScopedRoleMembershipCollectionRequest, SearchEntityQueryCollectionRequest, SectionGroupCollectionRequest, SecureScoreCollectionRequest, SecureScoreControlProfileCollectionRequest, SegmentCollectionRequest, ServicePrincipalCollectionReferenceRequest, ServicePrincipalCollectionRequest, ServicePrincipalCollectionWithReferencesRequest, ServicePrincipalDeltaCollectionRequest, SessionCollectionRequest, SettingStateDeviceSummaryCollectionRequest, SharedDriveItemCollectionRequest, SharedInsightCollectionRequest, ShiftCollectionRequest, SignInCollectionRequest, SingleValueLegacyExtendedPropertyCollectionRequest, SiteAddCollectionRequest, SiteCollectionReferenceRequest, SiteCollectionRequest, SiteCollectionWithReferencesRequest, SiteGetActivitiesByIntervalCollectionRequest, SiteRemoveCollectionRequest, SubscribedSkuCollectionRequest, SubscriptionCollectionRequest, SwapShiftsChangeRequestCollectionRequest, TargetedManagedAppConfigurationCollectionRequest, TargetedManagedAppPolicyAssignmentCollectionRequest, TeamCollectionRequest, TeamGetAllMessagesCollectionRequest, TeamsAppCollectionRequest, TeamsAppDefinitionCollectionRequest, TeamsAppInstallationCollectionRequest, TeamsAsyncOperationCollectionRequest, TeamsTabCollectionRequest, TeamsTemplateCollectionRequest, TelecomExpenseManagementPartnerCollectionRequest, TermsAndConditionsAcceptanceStatusCollectionRequest, TermsAndConditionsAssignmentCollectionRequest, TermsAndConditionsCollectionRequest, ThreatAssessmentRequestCollectionRequest, ThreatAssessmentResultCollectionRequest, ThumbnailSetCollectionRequest, TimeOffCollectionRequest, TimeOffReasonCollectionRequest, TimeOffRequestCollectionRequest, TodoTaskCollectionRequest, TodoTaskDeltaCollectionRequest, TodoTaskListCollectionRequest, TodoTaskListDeltaCollectionRequest, TokenIssuancePolicyCollectionReferenceRequest, TokenIssuancePolicyCollectionRequest, TokenIssuancePolicyCollectionWithReferencesRequest, TokenLifetimePolicyCollectionReferenceRequest, TokenLifetimePolicyCollectionRequest, TokenLifetimePolicyCollectionWithReferencesRequest, TrendingCollectionRequest, UsedInsightCollectionRequest, UserActivityCollectionRequest, UserActivityRecentCollectionRequest, UserCollectionReferenceRequest, UserCollectionRequest, UserCollectionWithReferencesRequest, UserDeltaCollectionRequest, UserGetMailTipsCollectionRequest, UserGetManagedAppDiagnosticStatusesCollectionRequest, UserGetManagedAppPoliciesCollectionRequest, UserInstallStateSummaryCollectionRequest, UserReminderViewCollectionRequest, UserScopeTeamsAppInstallationCollectionRequest, UserTranslateExchangeIdsCollectionRequest, VppTokenCollectionRequest, WindowsInformationProtectionAppLearningSummaryCollectionRequest, WindowsInformationProtectionAppLockerFileCollectionRequest, WindowsInformationProtectionNetworkLearningSummaryCollectionRequest, WindowsInformationProtectionPolicyCollectionRequest, WorkbookChartCollectionRequest, WorkbookChartPointCollectionRequest, WorkbookChartSeriesCollectionRequest, WorkbookCommentCollectionRequest, WorkbookCommentReplyCollectionRequest, WorkbookNamedItemCollectionRequest, WorkbookOperationCollectionRequest, WorkbookPivotTableCollectionRequest, WorkbookRangeBorderCollectionRequest, WorkbookRangeViewCollectionRequest, WorkbookTableCollectionRequest, WorkbookTableColumnCollectionRequest, WorkbookTableRowCollectionRequest, WorkbookWorksheetCollectionRequest, WorkforceIntegrationCollectionRequest

public abstract class BaseCollectionRequest<T1,T2>
extends java.lang.Object
implements IHttpRequest

A request against a collection

Constructor Summary

Constructors

Constructor and Description
BaseCollectionRequest(java.lang.String requestUrl, IBaseClient client, java.util.List<? extends Option> options, java.lang.Class<T1> responseClass, java.lang.Class<T2> collectionPageClass) Create the collection request

Method Summary

Modifier and Type	Method and Description
void	addFunctionOption(FunctionOption option) Adds a query option
void	addHeader(java.lang.String header, java.lang.String value) Adds a header to this request
void	addQueryOption(QueryOption option) Adds a query option
protected BaseRequest	getBaseRequest() Gets the base request for this collection request
java.lang.Class<T2>	getCollectionPageClass() Gets the class for the collection page
long	getDelay() Gets delay between retries
java.util.List<HeaderOption>	getHeaders() Gets the headers
HttpMethod	getHttpMethod() Gets the HTTP method
okhttp3.Request	getHttpRequest() Returns the Request object to be executed
<requestBodyType> okhttp3.Request	getHttpRequest(requestBodyType serializedObject) Returns the Request object to be executed
<requestBodyType,responseType> okhttp3.Request	getHttpRequest(requestBodyType serializedObject, IProgressCallback<responseType> progress) Returns the Request object to be executed
int	getMaxRedirects() Gets the max redirects
int	getMaxRetries() Gets max retries
java.util.List<Option>	getOptions() Gets the full list of options for this request
java.net.URL	getRequestUrl() Gets the request URL
com.microsoft.graph.httpcore.middlewareoption.IShouldRedirect	getShouldRedirect() Gets the should redirect callback
com.microsoft.graph.httpcore.middlewareoption.IShouldRetry	getShouldRetry() Gets the should retry callback
boolean	getUseCaches() Gets useCaches parameter
protected <BodyType> T1	post(BodyType serializedObject) Posts this request
protected T1	send() Send this request
void	setDelay(long delay) Sets the delay in seconds between retires
void	setMaxRedirects(int maxRedirects) Sets the max redirects
void	setMaxRetries(int maxRetries) Sets the max retries
void	setShouldRedirect(com.microsoft.graph.httpcore.middlewareoption.IShouldRedirect shouldRedirect) Sets the should redirect callback
void	setShouldRetry(com.microsoft.graph.httpcore.middlewareoption.IShouldRetry shouldretry) Sets the should retry callback
void	setUseCaches(boolean useCaches) Sets useCaches parameter to cache the response
IHttpRequest	withHttpMethod(HttpMethod httpMethod) Sets the HTTP method and returns the current request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseCollectionRequest

public BaseCollectionRequest(java.lang.String requestUrl,
                             IBaseClient client,
                             java.util.List<? extends Option> options,
                             java.lang.Class<T1> responseClass,
                             java.lang.Class<T2> collectionPageClass)

Create the collection request

Parameters:

requestUrl - the URL to make the request against

client - the client which can issue the request

options - the options for this request

responseClass - the class for the response

collectionPageClass - the class for the collection page

Method Detail

send

protected T1 send()
           throws ClientException

Send this request

Returns:

the response object

Throws:

ClientException - an exception occurs if there was an error while the request was sent

post

protected <BodyType> T1 post(BodyType serializedObject)
                      throws ClientException

Posts this request

Type Parameters:

BodyType - the type of the serialized body, some times Action use different body than collection item

Parameters:

serializedObject - the object to serialize as the body

Returns:

the response object

Throws:

ClientException - an exception occurs if there was an error while the request was sent

getRequestUrl

public java.net.URL getRequestUrl()

Gets the request URL

Specified by:

getRequestUrl in interface IHttpRequest

Returns:

the request URL

getHttpMethod

public HttpMethod getHttpMethod()

Gets the HTTP method

Specified by:

getHttpMethod in interface IHttpRequest

Returns:

the HTTP method

getHeaders

public java.util.List<HeaderOption> getHeaders()

Gets the headers

Specified by:

getHeaders in interface IHttpRequest

Returns:

the headers

addHeader

public void addHeader(java.lang.String header,
                      java.lang.String value)

Adds a header to this request

Specified by:

addHeader in interface IHttpRequest

Parameters:

header - the name of the header

value - the value of the header

setUseCaches

public void setUseCaches(boolean useCaches)

Sets useCaches parameter to cache the response

Specified by:

setUseCaches in interface IHttpRequest

Parameters:

useCaches - the value of useCaches

getUseCaches

public boolean getUseCaches()

Gets useCaches parameter

Specified by:

getUseCaches in interface IHttpRequest

Returns:

the value of useCaches

getOptions

public java.util.List<Option> getOptions()

Gets the full list of options for this request

Specified by:

getOptions in interface IHttpRequest

Returns:

the full list of options for this request

addQueryOption

public void addQueryOption(QueryOption option)

Adds a query option

Parameters:

option - the query option to add

addFunctionOption

public void addFunctionOption(FunctionOption option)

Adds a query option

Parameters:

option - the query option to add

getBaseRequest

protected BaseRequest getBaseRequest()

Gets the base request for this collection request

Returns:

the base request for this collection request

getCollectionPageClass

public java.lang.Class<T2> getCollectionPageClass()

Gets the class for the collection page

Returns:

the class for the collection page

setMaxRedirects

public void setMaxRedirects(int maxRedirects)

Sets the max redirects

Specified by:

setMaxRedirects in interface IHttpRequest

Parameters:

maxRedirects - Max redirects that a request can take

getMaxRedirects

public int getMaxRedirects()

Gets the max redirects

Specified by:

getMaxRedirects in interface IHttpRequest

Returns:

Max redirects that a request can take

setShouldRedirect

public void setShouldRedirect(com.microsoft.graph.httpcore.middlewareoption.IShouldRedirect shouldRedirect)

Sets the should redirect callback

Specified by:

setShouldRedirect in interface IHttpRequest

Parameters:

shouldRedirect - Callback called before doing a redirect

getShouldRedirect

public com.microsoft.graph.httpcore.middlewareoption.IShouldRedirect getShouldRedirect()

Gets the should redirect callback

Specified by:

getShouldRedirect in interface IHttpRequest

Returns:

Callback which is called before redirect

setShouldRetry

public void setShouldRetry(com.microsoft.graph.httpcore.middlewareoption.IShouldRetry shouldretry)

Sets the should retry callback

Specified by:

setShouldRetry in interface IHttpRequest

Parameters:

shouldretry - The callback called before retry

getShouldRetry

public com.microsoft.graph.httpcore.middlewareoption.IShouldRetry getShouldRetry()

Gets the should retry callback

Specified by:

getShouldRetry in interface IHttpRequest

Returns:

Callback called before retry

setMaxRetries

public void setMaxRetries(int maxRetries)

Sets the max retries

Specified by:

setMaxRetries in interface IHttpRequest

Parameters:

maxRetries - Max retries for a request

getMaxRetries

public int getMaxRetries()

Gets max retries

Specified by:

getMaxRetries in interface IHttpRequest

Returns:

Max retries for a request

setDelay

public void setDelay(long delay)

Sets the delay in seconds between retires

Specified by:

setDelay in interface IHttpRequest

Parameters:

delay - Delay in seconds between retries

getDelay

public long getDelay()

Gets delay between retries

Specified by:

getDelay in interface IHttpRequest

Returns:

Delay between retries in seconds

withHttpMethod

public IHttpRequest withHttpMethod(HttpMethod httpMethod)

Sets the HTTP method and returns the current request

Specified by:

withHttpMethod in interface IHttpRequest

Parameters:

httpMethod - the HTTP method

Returns:

the current request

getHttpRequest

public okhttp3.Request getHttpRequest()
                               throws ClientException

Returns the Request object to be executed

Specified by:

getHttpRequest in interface IHttpRequest

Returns:

the Request object to be executed

Throws:

ClientException

getHttpRequest

public <requestBodyType> okhttp3.Request getHttpRequest(requestBodyType serializedObject)
                                                 throws ClientException

Returns the Request object to be executed

Specified by:

getHttpRequest in interface IHttpRequest

Type Parameters:

requestBodyType - the type of the serialized object

Parameters:

serializedObject - the object to serialize at the body of the request

Returns:

the Request object to be executed

Throws:

ClientException

getHttpRequest

public <requestBodyType,responseType> okhttp3.Request getHttpRequest(requestBodyType serializedObject,
                                                                     IProgressCallback<responseType> progress)
                                                              throws ClientException

Returns the Request object to be executed

Specified by:

getHttpRequest in interface IHttpRequest

Type Parameters:

requestBodyType - the type of the serialized object

responseType - the type of the response object

Parameters:

serializedObject - the object to serialize at the body of the request

progress - the progress callback

Returns:

the Request object to be executed

Throws:

ClientException