class
GoogleDrive::Channel
- GoogleDrive::Channel
- Reference
- Object
Overview
An notification channel used to watch for resource changes.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
google_drive/models/channel.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, address : String | Nil = nil, expiration : String | Nil = nil, id : String | Nil = nil, kind : String | Nil = "api#channel", params : Hash(String, String) | Nil = nil, payload : Bool | Nil = nil, resource_id : String | Nil = nil, resource_uri : String | Nil = nil, token : String | Nil = nil, _type : String | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
-
#_type : String | Nil
The type of delivery mechanism used for this channel.
-
#_type=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#address : String | Nil
The address where notifications are delivered for this channel.
-
#address=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#expiration : String | Nil
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds.
-
#expiration=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
-
#id : String | Nil
A UUID or similar unique string that identifies this channel.
-
#id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#kind : String | Nil
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
-
#kind=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
-
#params : Hash(String, String) | Nil
Additional parameters controlling delivery channel behavior.
-
#params=(new_value : Hash(String, String) | Nil)
Custom attribute writer method checking allowed values (enum).
-
#payload : Bool | Nil
A Boolean value to indicate whether payload is wanted.
-
#payload=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
-
#resource_id : String | Nil
An opaque ID that identifies the resource being watched on this channel.
-
#resource_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#resource_uri : String | Nil
A version-specific identifier for the watched resource.
-
#resource_uri=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#token : String | Nil
An arbitrary string delivered to the target address with each notification delivered over this channel.
-
#token=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
clone
clone,
eql?(o : self)
eql?,
to_hash : Hash(String, JSON::Any)
to_hash,
to_json_any : JSON::Any
to_json_any
Class methods inherited from module OpenApi::Json
build_from_hash(hash : Hash)
build_from_hash,
build_from_json_any(json_any : JSON::Any)
build_from_json_any
Instance methods inherited from module OpenApi::Validatable
list_invalid_properties : Array(String)
list_invalid_properties,
list_invalid_properties_for(key : String) : Array(String)
list_invalid_properties_for,
valid? : Bool
valid?,
validate : Nil
validate
Instance methods inherited from module JSON::Serializable
to_hash : JSON::Any
to_hash
Class methods inherited from module JSON::Serializable
build_from_hash(hash : JSON::Any)
build_from_hash
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
The type of delivery mechanism used for this channel. Valid values are "web_hook" (or "webhook"). Both values refer to a channel where Http requests are used to deliver messages.
Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned
The address where notifications are delivered for this channel.
Custom attribute writer method checking allowed values (enum). @param [Object] address Object to be assigned
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
Custom attribute writer method checking allowed values (enum). @param [Object] expiration Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
Custom attribute writer method checking allowed values (enum). @param [Object] kind Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Additional parameters controlling delivery channel behavior. Optional.
Custom attribute writer method checking allowed values (enum). @param [Object] params Object to be assigned
A Boolean value to indicate whether payload is wanted. Optional.
Custom attribute writer method checking allowed values (enum). @param [Object] payload Object to be assigned
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
Custom attribute writer method checking allowed values (enum). @param [Object] resource_id Object to be assigned
A version-specific identifier for the watched resource.
Custom attribute writer method checking allowed values (enum). @param [Object] resource_uri Object to be assigned
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
Custom attribute writer method checking allowed values (enum). @param [Object] token Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid