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.

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



219
220
221
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 219

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

Instance Attribute Details

#alert_idString

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

Returns:

  • (String)


149
150
151
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 149

def alert_id
  @alert_id
end

#create_timeString

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

Returns:

  • (String)


154
155
156
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 154

def create_time
  @create_time
end

#customer_idString

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

Returns:

  • (String)


159
160
161
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 159

def customer_id
  @customer_id
end

#dataHash<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>)


165
166
167
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 165

def data
  @data
end

#deletedBoolean Also known as: deleted?

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

Returns:

  • (Boolean)


170
171
172
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 170

def deleted
  @deleted
end

#end_timeString

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, it indicates an ongoing alert. Corresponds to the JSON property endTime

Returns:

  • (String)


178
179
180
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 178

def end_time
  @end_time
end

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

Returns:

  • (String)


185
186
187
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 185

def security_investigation_tool_link
  @security_investigation_tool_link
end

#sourceString

Required. A unique identifier for the system that reported the alert. This is output only after alert is created. 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)


198
199
200
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 198

def source
  @source
end

#start_timeString

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

Returns:

  • (String)


204
205
206
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 204

def start_time
  @start_time
end

#typeString

Required. The type of the alert. This is output only after alert is created. For a list of available alert types see G Suite Alert types. Corresponds to the JSON property type

Returns:

  • (String)


212
213
214
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 212

def type
  @type
end

#update_timeString

Output only. The time this alert was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String)


217
218
219
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 217

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'generated/google/apis/alertcenter_v1beta1/classes.rb', line 224

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)
  @update_time = args[:update_time] if args.key?(:update_time)
end