Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Context

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dialogflow_v2/classes.rb,
generated/google/apis/dialogflow_v2/representations.rb,
generated/google/apis/dialogflow_v2/representations.rb

Overview

Represents a context.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Context

Returns a new instance of GoogleCloudDialogflowV2beta1Context.



3804
3805
3806
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3804

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#lifespan_count ⇒ Fixnum

Optional. The number of conversational query requests after which the context expires. If set to 0 (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. Corresponds to the JSON property lifespanCount

Returns:

  • (Fixnum) 


3777
3778
3779
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3777

def lifespan_count
  @lifespan_count
end

#name ⇒ String

Required. The unique identifier of the context. Format: projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>. The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If Environment ID is not specified, we assume default 'draft' environment. If User ID is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:

  • __system_counters__
  • *_id_dialog_context
  • *_dialog_params_size Corresponds to the JSON property name

Returns:

  • (String) 


3794
3795
3796
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3794

def name
  @name
end

#parameters ⇒ Hash<String,Object>

Optional. The collection of parameters associated with this context. Refer to this doc for syntax. Corresponds to the JSON property parameters

Returns:

  • (Hash<String,Object>) 


3802
3803
3804
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3802

def parameters
  @parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3809
3810
3811
3812
3813
 
# File 'generated/google/apis/dialogflow_v2/classes.rb', line 3809

def update!(**args)
  @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count)
  @name = args[:name] if args.key?(:name)
  @parameters = args[:parameters] if args.key?(:parameters)
end