com.microsoft.graph.models.extensions

Class Subscription

java.lang.Object

com.microsoft.graph.models.extensions.Entity

com.microsoft.graph.models.extensions.Subscription

All Implemented Interfaces:

IJsonBackedObject

public class Subscription
extends Entity
implements IJsonBackedObject

The class for the Subscription.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	applicationId The Application Id.
java.lang.String	changeType The Change Type.
java.lang.String	clientState The Client State.
java.lang.String	creatorId The Creator Id.
java.lang.String	encryptionCertificate The Encryption Certificate.
java.lang.String	encryptionCertificateId The Encryption Certificate Id.
java.util.Calendar	expirationDateTime The Expiration Date Time.
java.lang.Boolean	includeResourceData The Include Resource Data.
java.lang.String	latestSupportedTlsVersion The Latest Supported Tls Version.
java.lang.String	lifecycleNotificationUrl The Lifecycle Notification Url.
java.lang.String	notificationUrl The Notification Url.
java.lang.String	resource The Resource.

Fields inherited from class com.microsoft.graph.models.extensions.Entity

id, oDataType

Constructor Summary

Constructors

Constructor and Description
Subscription()

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	getRawObject() Gets the raw representation of this class
protected ISerializer	getSerializer() Gets serializer
void	setRawObject(ISerializer serializer, com.google.gson.JsonObject json) Sets the raw JSON object

Methods inherited from class com.microsoft.graph.models.extensions.Entity

additionalDataManager

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.serializer.IJsonBackedObject

additionalDataManager

Field Detail

applicationId

@SerializedName(value="applicationId",
                alternate="ApplicationId")
 @Expose
public java.lang.String applicationId

The Application Id. Identifier of the application used to create the subscription. Read-only.

changeType

@SerializedName(value="changeType",
                alternate="ChangeType")
 @Expose
public java.lang.String changeType

The Change Type. Required. Indicates the type of change in the subscribed resource that will raise a change notification. The supported values are: created, updated, deleted. Multiple values can be combined using a comma-separated list.Note: Drive root item and list change notifications support only the updated changeType. User and group change notifications support updated and deleted changeType.

clientState

@SerializedName(value="clientState",
                alternate="ClientState")
 @Expose
public java.lang.String clientState

The Client State. Optional. Specifies the value of the clientState property sent by the service in each change notification. The maximum length is 128 characters. The client can check that the change notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each change notification.

creatorId

@SerializedName(value="creatorId",
                alternate="CreatorId")
 @Expose
public java.lang.String creatorId

The Creator Id. Identifier of the user or service principal that created the subscription. If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. If the app used application permissions, this field contains the id of the service principal corresponding to the app. Read-only.

encryptionCertificate

@SerializedName(value="encryptionCertificate",
                alternate="EncryptionCertificate")
 @Expose
public java.lang.String encryptionCertificate

The Encryption Certificate. A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Optional. Required when includeResourceData is true.

encryptionCertificateId

@SerializedName(value="encryptionCertificateId",
                alternate="EncryptionCertificateId")
 @Expose
public java.lang.String encryptionCertificateId

The Encryption Certificate Id. A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Optional.

expirationDateTime

@SerializedName(value="expirationDateTime",
                alternate="ExpirationDateTime")
 @Expose
public java.util.Calendar expirationDateTime

The Expiration Date Time. Required. Specifies the date and time when the webhook subscription expires. The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. See the table below for maximum supported subscription length of time.

includeResourceData

@SerializedName(value="includeResourceData",
                alternate="IncludeResourceData")
 @Expose
public java.lang.Boolean includeResourceData

The Include Resource Data. When set to true, change notifications include resource data (such as content of a chat message). Optional.

latestSupportedTlsVersion

@SerializedName(value="latestSupportedTlsVersion",
                alternate="LatestSupportedTlsVersion")
 @Expose
public java.lang.String latestSupportedTlsVersion

The Latest Supported Tls Version. Specifies the latest version of Transport Layer Security (TLS) that the notification endpoint, specified by notificationUrl, supports. The possible values are: v1_0, v1_1, v1_2, v1_3. For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2. For these subscribers, not setting this property per the timeline would result in subscription operations failing. For subscribers whose notification endpoint already supports TLS 1.2, setting this property is optional. In such cases, Microsoft Graph defaults the property to v1_2.

lifecycleNotificationUrl

@SerializedName(value="lifecycleNotificationUrl",
                alternate="LifecycleNotificationUrl")
 @Expose
public java.lang.String lifecycleNotificationUrl

The Lifecycle Notification Url. The URL of the endpoint that receives lifecycle notifications, including subscriptionRemoved and missed notifications. This URL must make use of the HTTPS protocol. Optional. Read more about how Outlook resources use lifecycle notifications.

notificationUrl

@SerializedName(value="notificationUrl",
                alternate="NotificationUrl")
 @Expose
public java.lang.String notificationUrl

The Notification Url. Required. The URL of the endpoint that will receive the change notifications. This URL must make use of the HTTPS protocol.

resource

@SerializedName(value="resource",
                alternate="Resource")
 @Expose
public java.lang.String resource

The Resource. Required. Specifies the resource that will be monitored for changes. Do not include the base URL (https://graph.microsoft.com/v1.0/). See the possible resource path values for each supported resource.

Constructor Detail

Subscription

public Subscription()

Method Detail

getRawObject

public com.google.gson.JsonObject getRawObject()

Gets the raw representation of this class

Overrides:

getRawObject in class Entity

Returns:

the raw representation of this class

getSerializer

protected ISerializer getSerializer()

Gets serializer

Overrides:

getSerializer in class Entity

Returns:

the serializer

setRawObject

public void setRawObject(ISerializer serializer,
                         com.google.gson.JsonObject json)

Sets the raw JSON object

Specified by:

setRawObject in interface IJsonBackedObject

Overrides:

setRawObject in class Entity

Parameters:

serializer - the serializer

json - the JSON object to set this object to