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

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

Overview

An alert affecting a customer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Alert

Returns a new instance of Alert.



241
242
243
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 241

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) 


161
162
163
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 161

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) 


166
167
168
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 166

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) 


171
172
173
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 171

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


177
178
179
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 177

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) 


182
183
184
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 182

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

Returns:

  • (String) 


190
191
192
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 190

def end_time
  @end_time
end

#etag ⇒ String

Optional. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of an alert from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify- write cycle to perform alert updates in order to avoid race conditions: An etag is returned in the response which contains alerts, and systems are expected to put that etag in the request to update alert to ensure that their change will be applied to the same version of the alert. If no etag is provided in the call to update alert, then the existing alert is overwritten blindly. Corresponds to the JSON property etag

Returns:

  • (String) 


203
204
205
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 203

def etag
  @etag
end

#metadata ⇒ Google::Apis::AlertcenterV1beta1::AlertMetadata

An alert metadata. Corresponds to the JSON property metadata

Returns:



208
209
210
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 208

def metadata
  @metadata
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) 


214
215
216
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 214

def security_investigation_tool_link
  @security_investigation_tool_link
end

#source ⇒ String

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 * State sponsored attack * Google identity Corresponds to the JSON property source

Returns:

  • (String) 


222
223
224
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 222

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) 


227
228
229
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 227

def start_time
  @start_time
end

#type ⇒ String

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

Returns:

  • (String) 


234
235
236
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 234

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


239
240
241
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 239

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 246

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