Channel (Google Drive API v3-rev20241027-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.drive.model.Channel

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Channel
extends com.google.api.client.json.GenericJson
```
A 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 Google 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
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Channel()

Constructors
Constructor and Description
`Channel()`

Method Summary

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

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - getAddress
```
public String getAddress()
```
    The address where notifications are delivered for this channel.
    
    Returns:
    
    value or null for none
  - setAddress
```
public Channel setAddress(String address)
```
    The address where notifications are delivered for this channel.
    
    Parameters:
    
    address - address or null for none
  - getExpiration
```
public 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(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 String getId()
```
    A UUID or similar unique string that identifies this channel.
    
    Returns:
    
    value or null for none
  - setId
```
public Channel setId(String id)
```
    A UUID or similar unique string that identifies this channel.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
    
    Returns:
    
    value or null for none
  - setKind
```
public Channel setKind(String kind)
```
    Identifies this as a notification channel used to watch for changes to a resource, which is `api#channel`.
    
    Parameters:
    
    kind - kind or null for none
  - getParams
```
public Map<String,String> getParams()
```
    Additional parameters controlling delivery channel behavior. Optional.
    
    Returns:
    
    value or null for none
  - setParams
```
public Channel setParams(Map<String,String> params)
```
    Additional parameters controlling delivery channel behavior. Optional.
    
    Parameters:
    
    params - params or null for none
  - getPayload
```
public Boolean getPayload()
```
    A Boolean value to indicate whether payload is wanted. Optional.
    
    Returns:
    
    value or null for none
  - setPayload
```
public Channel setPayload(Boolean payload)
```
    A Boolean value to indicate whether payload is wanted. Optional.
    
    Parameters:
    
    payload - payload or null for none
  - getResourceId
```
public 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(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 String getResourceUri()
```
    A version-specific identifier for the watched resource.
    
    Returns:
    
    value or null for none
  - setResourceUri
```
public Channel setResourceUri(String resourceUri)
```
    A version-specific identifier for the watched resource.
    
    Parameters:
    
    resourceUri - resourceUri or null for none
  - getToken
```
public 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(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 String getType()
```
    The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
    
    Returns:
    
    value or null for none
  - setType
```
public Channel setType(String type)
```
    The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook".
    
    Parameters:
    
    type - type or null for none
  - set
```
public Channel set(String fieldName,
                   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

Class Channel

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Channel

Method Detail

getAddress

setAddress

getExpiration

setExpiration

getId

setId

getKind

setKind

getParams

setParams

getPayload

setPayload

getResourceId

setResourceId

getResourceUri

setResourceUri

getToken

setToken

getType

setType

set

clone