Class: Google::Apis::CloudsearchV1::ClientContext

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Represents the context of the client on behalf of which a HistoryRecord is produced. The ClientContext message can be used to hold context about the service client (e.g. the internal server making fusebox requests) or the user client (e.g. the IP address of the end user).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ClientContext

Returns a new instance of ClientContext.



5948
5949
5950
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5948

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

Instance Attribute Details

#client_operation_id ⇒ String

The client operation to which this history record belongs. The notion of a client operation is provided to keep track of client operations which might span multiple transactions in the lower level. Corresponds to the JSON property clientOperationId

Returns:

  • (String) 


5930
5931
5932
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5930

def client_operation_id
  @client_operation_id
end

#client_type ⇒ String

E.g. "pinto", "imap", "bigtop", "upload" Corresponds to the JSON property clientType

Returns:

  • (String) 


5935
5936
5937
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5935

def client_type
  @client_type
end

#session_context ⇒ Google::Apis::CloudsearchV1::SessionContext

Contains information about the session which created this history record. This will be empty if the history record was generated by an internal request. Corresponds to the JSON property sessionContext

Returns:



5941
5942
5943
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5941

def session_context
  @session_context
end

#user_ip ⇒ String

Textual representation of the user's IP address, if available. Corresponds to the JSON property userIp

Returns:

  • (String) 


5946
5947
5948
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5946

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5953
5954
5955
5956
5957
5958
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 5953

def update!(**args)
  @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id)
  @client_type = args[:client_type] if args.key?(:client_type)
  @session_context = args[:session_context] if args.key?(:session_context)
  @user_ip = args[:user_ip] if args.key?(:user_ip)
end