Class: Google::Apis::AlertcenterV1beta1::Alert

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

Overview

An alert affecting a customer. All fields are read-only once created.

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) ⇒ Alert

Returns a new instance of Alert



121
122
123
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 121

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

Instance Attribute Details

#alert_id ⇒ String

Output only. The unique identifier for the alert. Corresponds to the JSON property alertId

Returns:

  • (String) 


58
59
60
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 58

def alert_id
  @alert_id
end

#create_time ⇒ String

Output only. The time this alert was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


63
64
65
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 63

def create_time
  @create_time
end

#customer_id ⇒ String

Output only. The unique identifier of the Google account of the customer. Corresponds to the JSON property customerId

Returns:

  • (String) 


68
69
70
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 68

def customer_id
  @customer_id
end

#data ⇒ Hash<String,Object>

Optional. The data associated with this alert, for example google.apps.alertcenter.type.DeviceCompromised. Corresponds to the JSON property data

Returns:

  • (Hash<String,Object>) 


74
75
76
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 74

def data
  @data
end

#deleted ⇒ Boolean Also known as: deleted?

Output only. True if this alert is marked for deletion. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


79
80
81
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 79

def deleted
  @deleted
end

#end_time ⇒ String

Optional. The time the event that caused this alert ceased being active. If provided, the end time must not be earlier than the start time. If not provided, the end time defaults to the start time. Corresponds to the JSON property endTime

Returns:

  • (String) 


87
88
89
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 87

def end_time
  @end_time
end

#security_investigation_tool_link ⇒ String

Output only. An optional Security Investigation Tool query for this alert. Corresponds to the JSON property securityInvestigationToolLink

Returns:

  • (String) 


94
95
96
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 94

def security_investigation_tool_link
  @security_investigation_tool_link
end

#source ⇒ String

Required. A unique identifier for the system that is reported the alert. Supported sources are any of the following:

  • Google Operations
  • Mobile device management
  • Gmail phishing
  • Domain wide takeout
  • Government attack warning
  • Google identity Corresponds to the JSON property source

Returns:

  • (String) 


106
107
108
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 106

def source
  @source
end

#start_time ⇒ String

Required. The time the event that caused this alert was started or detected. Corresponds to the JSON property startTime

Returns:

  • (String) 


112
113
114
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 112

def start_time
  @start_time
end

#type ⇒ String

Required. The type of the alert. For a list of available alert types see G Suite Alert types. Corresponds to the JSON property type

Returns:

  • (String) 


119
120
121
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 119

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 126

def update!(**args)
  @alert_id = args[:alert_id] if args.key?(:alert_id)
  @create_time = args[:create_time] if args.key?(:create_time)
  @customer_id = args[:customer_id] if args.key?(:customer_id)
  @data = args[:data] if args.key?(:data)
  @deleted = args[:deleted] if args.key?(:deleted)
  @end_time = args[:end_time] if args.key?(:end_time)
  @security_investigation_tool_link = args[:security_investigation_tool_link] if args.key?(:security_investigation_tool_link)
  @source = args[:source] if args.key?(:source)
  @start_time = args[:start_time] if args.key?(:start_time)
  @type = args[:type] if args.key?(:type)
end