com.google.api.services.drive.model

Class Channel

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.drive.model.Channel

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Channel
extends com.google.api.client.json.GenericJson

An notification channel used to watch for resource changes.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Drive API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Channel()

Method Summary

Methods

Modifier and Type	Method and Description
Channel	clone()
java.lang.String	getAddress() The address where notifications are delivered for this channel.
java.lang.Long	getExpiration() Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds.
java.lang.String	getId() A UUID or similar unique string that identifies this channel.
java.lang.String	getKind() Identifies this as a notification channel used to watch for changes to a resource.
java.util.Map<java.lang.String,java.lang.String>	getParams() Additional parameters controlling delivery channel behavior.
java.lang.Boolean	getPayload() A Boolean value to indicate whether payload is wanted.
java.lang.String	getResourceId() An opaque ID that identifies the resource being watched on this channel.
java.lang.String	getResourceUri() A version-specific identifier for the watched resource.
java.lang.String	getToken() An arbitrary string delivered to the target address with each notification delivered over this channel.
java.lang.String	getType() The type of delivery mechanism used for this channel.
Channel	set(java.lang.String fieldName, java.lang.Object value)
Channel	setAddress(java.lang.String address) The address where notifications are delivered for this channel.
Channel	setExpiration(java.lang.Long expiration) Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds.
Channel	setId(java.lang.String id) A UUID or similar unique string that identifies this channel.
Channel	setKind(java.lang.String kind) Identifies this as a notification channel used to watch for changes to a resource.
Channel	setParams(java.util.Map<java.lang.String,java.lang.String> params) Additional parameters controlling delivery channel behavior.
Channel	setPayload(java.lang.Boolean payload) A Boolean value to indicate whether payload is wanted.
Channel	setResourceId(java.lang.String resourceId) An opaque ID that identifies the resource being watched on this channel.
Channel	setResourceUri(java.lang.String resourceUri) A version-specific identifier for the watched resource.
Channel	setToken(java.lang.String token) An arbitrary string delivered to the target address with each notification delivered over this channel.
Channel	setType(java.lang.String type) The type of delivery mechanism used for this channel.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Channel

public Channel()

Method Detail

getAddress

public java.lang.String getAddress()

The address where notifications are delivered for this channel.

Returns:

value or null for none

setAddress

public Channel setAddress(java.lang.String address)

The address where notifications are delivered for this channel.

Parameters:

address - address or null for none

getExpiration

public java.lang.Long getExpiration()

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Returns:

value or null for none

setExpiration

public Channel setExpiration(java.lang.Long expiration)

Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

Parameters:

expiration - expiration or null for none

getId

public java.lang.String getId()

A UUID or similar unique string that identifies this channel.

Returns:

value or null for none

setId

public Channel setId(java.lang.String id)

A UUID or similar unique string that identifies this channel.

Parameters:

id - id or null for none

getKind

public java.lang.String getKind()

Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".

Returns:

value or null for none

setKind

public Channel setKind(java.lang.String kind)

Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".

Parameters:

kind - kind or null for none

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Additional parameters controlling delivery channel behavior. Optional.

Returns:

value or null for none

setParams

public Channel setParams(java.util.Map<java.lang.String,java.lang.String> params)

Additional parameters controlling delivery channel behavior. Optional.

Parameters:

params - params or null for none

getPayload

public java.lang.Boolean getPayload()

A Boolean value to indicate whether payload is wanted. Optional.

Returns:

value or null for none

setPayload

public Channel setPayload(java.lang.Boolean payload)

A Boolean value to indicate whether payload is wanted. Optional.

Parameters:

payload - payload or null for none

getResourceId

public java.lang.String getResourceId()

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Returns:

value or null for none

setResourceId

public Channel setResourceId(java.lang.String resourceId)

An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

Parameters:

resourceId - resourceId or null for none

getResourceUri

public java.lang.String getResourceUri()

A version-specific identifier for the watched resource.

Returns:

value or null for none

setResourceUri

public Channel setResourceUri(java.lang.String resourceUri)

A version-specific identifier for the watched resource.

Parameters:

resourceUri - resourceUri or null for none

getToken

public java.lang.String getToken()

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Returns:

value or null for none

setToken

public Channel setToken(java.lang.String token)

An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

Parameters:

token - token or null for none

getType

public java.lang.String getType()

The type of delivery mechanism used for this channel.

Returns:

value or null for none

setType

public Channel setType(java.lang.String type)

The type of delivery mechanism used for this channel.

Parameters:

type - type or null for none

set

public Channel set(java.lang.String fieldName,
          java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Channel clone()

Overrides:

clone in class com.google.api.client.json.GenericJson