Class: Google::Apis::AlertcenterV1beta1::AlertCenterService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AlertcenterV1beta1::AlertCenterService
- Defined in:
- generated/google/apis/alertcenter_v1beta1/service.rb
Overview
G Suite Alert Center API
Manages alerts on issues affecting your domain.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#batch_delete_alerts(batch_delete_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::BatchDeleteAlertsResponse
Performs batch delete operation on alerts.
-
#batch_undelete_alerts(batch_undelete_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::BatchUndeleteAlertsResponse
Performs batch undelete operation on alerts.
-
#create_alert_feedback(alert_id, alert_feedback_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::AlertFeedback
Creates new feedback for an alert.
-
#delete_alert(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Empty
Marks the specified alert for deletion.
-
#get_alert(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Alert
Gets the specified alert.
-
#get_alert_metadata(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::AlertMetadata
Returns the metadata of an alert.
-
#get_settings(customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Settings
Returns customer-level settings.
-
#initialize ⇒ AlertCenterService
constructor
A new instance of AlertCenterService.
-
#list_alert_feedbacks(alert_id, customer_id: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::ListAlertFeedbackResponse
Lists all the feedback for an alert.
-
#list_alerts(customer_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::ListAlertsResponse
Lists the alerts.
-
#undelete_alert(alert_id, undelete_alert_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Alert
Restores, or "undeletes", an alert that was marked for deletion within the past 30 days.
-
#update_settings(settings_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Settings
Updates the customer-level settings.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ AlertCenterService
Returns a new instance of AlertCenterService.
45 46 47 48 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 45 def initialize super('https://alertcenter.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#batch_delete_alerts(batch_delete_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::BatchDeleteAlertsResponse
Performs batch delete operation on alerts.
69 70 71 72 73 74 75 76 77 78 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 69 def batch_delete_alerts(batch_delete_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/alerts:batchDelete', ) command.request_representation = Google::Apis::AlertcenterV1beta1::BatchDeleteAlertsRequest::Representation command.request_object = batch_delete_alerts_request_object command.response_representation = Google::Apis::AlertcenterV1beta1::BatchDeleteAlertsResponse::Representation command.response_class = Google::Apis::AlertcenterV1beta1::BatchDeleteAlertsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#batch_undelete_alerts(batch_undelete_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::BatchUndeleteAlertsResponse
Performs batch undelete operation on alerts.
99 100 101 102 103 104 105 106 107 108 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 99 def batch_undelete_alerts(batch_undelete_alerts_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/alerts:batchUndelete', ) command.request_representation = Google::Apis::AlertcenterV1beta1::BatchUndeleteAlertsRequest::Representation command.request_object = batch_undelete_alerts_request_object command.response_representation = Google::Apis::AlertcenterV1beta1::BatchUndeleteAlertsResponse::Representation command.response_class = Google::Apis::AlertcenterV1beta1::BatchUndeleteAlertsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_alert_feedback(alert_id, alert_feedback_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::AlertFeedback
Creates new feedback for an alert. Attempting to create a feedback for
a non-existent alert returns NOT_FOUND
error. Attempting to create a
feedback for an alert that is marked for deletion returns
`FAILED_PRECONDITION' error.
343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 343 def create_alert_feedback(alert_id, alert_feedback_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/alerts/{alertId}/feedback', ) command.request_representation = Google::Apis::AlertcenterV1beta1::AlertFeedback::Representation command.request_object = alert_feedback_object command.response_representation = Google::Apis::AlertcenterV1beta1::AlertFeedback::Representation command.response_class = Google::Apis::AlertcenterV1beta1::AlertFeedback command.params['alertId'] = alert_id unless alert_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_alert(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Empty
Marks the specified alert for deletion. An alert that has been marked for
deletion is removed from Alert Center after 30 days.
Marking an alert for deletion has no effect on an alert which has
already been marked for deletion. Attempting to mark a nonexistent alert
for deletion results in a NOT_FOUND
error.
138 139 140 141 142 143 144 145 146 147 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 138 def delete_alert(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/alerts/{alertId}', ) command.response_representation = Google::Apis::AlertcenterV1beta1::Empty::Representation command.response_class = Google::Apis::AlertcenterV1beta1::Empty command.params['alertId'] = alert_id unless alert_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_alert(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Alert
Gets the specified alert. Attempting to get a nonexistent alert returns
NOT_FOUND
error.
174 175 176 177 178 179 180 181 182 183 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 174 def get_alert(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/alerts/{alertId}', ) command.response_representation = Google::Apis::AlertcenterV1beta1::Alert::Representation command.response_class = Google::Apis::AlertcenterV1beta1::Alert command.params['alertId'] = alert_id unless alert_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_alert_metadata(alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::AlertMetadata
Returns the metadata of an alert. Attempting to get metadata for
a non-existent alert returns NOT_FOUND
error.
210 211 212 213 214 215 216 217 218 219 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 210 def (alert_id, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/alerts/{alertId}/metadata', ) command.response_representation = Google::Apis::AlertcenterV1beta1::AlertMetadata::Representation command.response_class = Google::Apis::AlertcenterV1beta1::AlertMetadata command.params['alertId'] = alert_id unless alert_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_settings(customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Settings
Returns customer-level settings.
422 423 424 425 426 427 428 429 430 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 422 def get_settings(customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/settings', ) command.response_representation = Google::Apis::AlertcenterV1beta1::Settings::Representation command.response_class = Google::Apis::AlertcenterV1beta1::Settings command.query['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_alert_feedbacks(alert_id, customer_id: nil, filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::ListAlertFeedbackResponse
Lists all the feedback for an alert. Attempting to list feedbacks for
a non-existent alert returns NOT_FOUND
error.
388 389 390 391 392 393 394 395 396 397 398 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 388 def list_alert_feedbacks(alert_id, customer_id: nil, filter: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/alerts/{alertId}/feedback', ) command.response_representation = Google::Apis::AlertcenterV1beta1::ListAlertFeedbackResponse::Representation command.response_class = Google::Apis::AlertcenterV1beta1::ListAlertFeedbackResponse command.params['alertId'] = alert_id unless alert_id.nil? command.query['customerId'] = customer_id unless customer_id.nil? command.query['filter'] = filter unless filter.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_alerts(customer_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::ListAlertsResponse
Lists the alerts.
264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 264 def list_alerts(customer_id: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/alerts', ) command.response_representation = Google::Apis::AlertcenterV1beta1::ListAlertsResponse::Representation command.response_class = Google::Apis::AlertcenterV1beta1::ListAlertsResponse command.query['customerId'] = customer_id unless customer_id.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#undelete_alert(alert_id, undelete_alert_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Alert
Restores, or "undeletes", an alert that was marked for deletion within the
past 30 days. Attempting to undelete an alert which was marked for deletion
over 30 days ago (which has been removed from the Alert Center database) or
a nonexistent alert returns a NOT_FOUND
error. Attempting to
undelete an alert which has not been marked for deletion has no effect.
303 304 305 306 307 308 309 310 311 312 313 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 303 def undelete_alert(alert_id, undelete_alert_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta1/alerts/{alertId}:undelete', ) command.request_representation = Google::Apis::AlertcenterV1beta1::UndeleteAlertRequest::Representation command.request_object = undelete_alert_request_object command.response_representation = Google::Apis::AlertcenterV1beta1::Alert::Representation command.response_class = Google::Apis::AlertcenterV1beta1::Alert command.params['alertId'] = alert_id unless alert_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_settings(settings_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AlertcenterV1beta1::Settings
Updates the customer-level settings.
455 456 457 458 459 460 461 462 463 464 465 |
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 455 def update_settings(settings_object = nil, customer_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta1/settings', ) command.request_representation = Google::Apis::AlertcenterV1beta1::Settings::Representation command.request_object = settings_object command.response_representation = Google::Apis::AlertcenterV1beta1::Settings::Representation command.response_class = Google::Apis::AlertcenterV1beta1::Settings command.query['customerId'] = customer_id unless customer_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |