Class: Aws::Connect::Types::ReferenceSummary

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::ReferenceSummary

Includes:

Structure, Structure::Union

Defined in:

lib/aws-sdk-connect/types.rb

Overview

Note:

ReferenceSummary is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ReferenceSummary corresponding to the set member.

Contains summary information about a reference. ‘ReferenceSummary` contains only one non null field between the URL and attachment based on the reference type.

See Also:

• AWS API Documentation

Direct Known Subclasses

Attachment, Date, Email, EmailMessage, EmailMessagePlainText, Number, String, Unknown, Url

Defined Under Namespace

Classes: Attachment, Date, Email, EmailMessage, EmailMessagePlainText, Number, String, Unknown, Url

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attachment ⇒ Types::AttachmentReference

  Information about the reference when the ‘referenceType` is `ATTACHMENT`.

• #date ⇒ Types::DateReference

  Information about a reference when the ‘referenceType` is `DATE`.

• #email ⇒ Types::EmailReference

  Information about a reference when the ‘referenceType` is `EMAIL`.

• #email_message ⇒ Types::EmailMessageReference

  Information about the reference when the referenceType is ‘EMAIL_MESSAGE`.

• #email_message_plain_text ⇒ Types::EmailMessageReference

  Information about the reference when the referenceType is ‘EMAIL_MESSAGE`.

• #number ⇒ Types::NumberReference

  Information about a reference when the ‘referenceType` is `NUMBER`.

• #string ⇒ Types::StringReference

  Information about a reference when the ‘referenceType` is `STRING`.

• #unknown ⇒ Object

  Returns the value of attribute unknown.

• #url ⇒ Types::UrlReference

  Information about the reference when the ‘referenceType` is `URL`.

Instance Attribute Details

#attachment ⇒ Types::AttachmentReference

Information about the reference when the ‘referenceType` is `ATTACHMENT`. Otherwise, null.

Returns:

• (Types::AttachmentReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#date ⇒ Types::DateReference

Information about a reference when the ‘referenceType` is `DATE`. Otherwise, null.

Returns:

• (Types::DateReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#email ⇒ Types::EmailReference

Information about a reference when the ‘referenceType` is `EMAIL`. Otherwise, null.

Returns:

• (Types::EmailReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#email_message ⇒ Types::EmailMessageReference

Information about the reference when the referenceType is ‘EMAIL_MESSAGE`. Otherwise, null.

Returns:

• (Types::EmailMessageReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#email_message_plain_text ⇒ Types::EmailMessageReference

Information about the reference when the referenceType is ‘EMAIL_MESSAGE`. Otherwise, null.

Returns:

• (Types::EmailMessageReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#number ⇒ Types::NumberReference

Information about a reference when the ‘referenceType` is `NUMBER`. Otherwise, null.

Returns:

• (Types::NumberReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#string ⇒ Types::StringReference

Information about a reference when the ‘referenceType` is `STRING`. Otherwise, null.

Returns:

• (Types::StringReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

• (Object) —

  the current value of unknown

# File 'lib/aws-sdk-connect/types.rb', line 26863

def unknown
  @unknown
end

#url ⇒ Types::UrlReference

Information about the reference when the ‘referenceType` is `URL`. Otherwise, null.

Returns:

• (Types::UrlReference)

# File 'lib/aws-sdk-connect/types.rb', line 26863

class ReferenceSummary < Struct.new(
  :url,
  :attachment,
  :email_message,
  :email_message_plain_text,
  :string,
  :number,
  :date,
  :email,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Url < ReferenceSummary; end
  class Attachment < ReferenceSummary; end
  class EmailMessage < ReferenceSummary; end
  class EmailMessagePlainText < ReferenceSummary; end
  class String < ReferenceSummary; end
  class Number < ReferenceSummary; end
  class Date < ReferenceSummary; end
  class Email < ReferenceSummary; end
  class Unknown < ReferenceSummary; end
end