Class: Aws::Pinpoint::Types::Event

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::Event

Defined in:

gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Specifies information about an event that reports data to Amazon Pinpoint.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_package_name ⇒ String

  The package name of the app that's recording the event.

• #app_title ⇒ String

  The title of the app that's recording the event.

• #app_version_code ⇒ String

  The version number of the app that's recording the event.

• #attributes ⇒ Hash<String,String>

  One or more custom attributes that are associated with the event.

• #client_sdk_version ⇒ String

  The version of the SDK that's running on the client device.

• #event_type ⇒ String

  The name of the event.

• #metrics ⇒ Hash<String,Float>

  One or more custom metrics that are associated with the event.

• #sdk_name ⇒ String

  The name of the SDK that's being used to record the event.

• #session ⇒ Types::Session

  Information about the session in which the event occurred.

• #timestamp ⇒ String

  The date and time, in ISO 8601 format, when the event occurred.

Instance Attribute Details

#app_package_name ⇒ String

The package name of the app that's recording the event.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#app_title ⇒ String

The title of the app that's recording the event.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#app_version_code ⇒ String

The version number of the app that's recording the event.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

One or more custom attributes that are associated with the event.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#client_sdk_version ⇒ String

The version of the SDK that's running on the client device.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ String

The name of the event.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Hash<String,Float>

One or more custom metrics that are associated with the event.

Returns:

• (Hash<String,Float>)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#sdk_name ⇒ String

The name of the SDK that's being used to record the event.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#session ⇒ Types::Session

Information about the session in which the event occurred.

Returns:

• (Types::Session)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ String

The date and time, in ISO 8601 format, when the event occurred.

Returns:

• (String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5137

class Event < Struct.new(
  :app_package_name,
  :app_title,
  :app_version_code,
  :attributes,
  :client_sdk_version,
  :event_type,
  :metrics,
  :sdk_name,
  :session,
  :timestamp)
  SENSITIVE = []
  include Aws::Structure
end