Class: Google::Apis::AlertcenterV1beta1::AlertCenterService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/alertcenter_v1beta1/service.rb

Overview

G Suite Alert Center API

Manages alerts on issues affecting your domain.

Examples:

require 'google/apis/alertcenter_v1beta1'

Alertcenter = Google::Apis::AlertcenterV1beta1 # Alias the module
service = Alertcenter::AlertCenterService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeAlertCenterService

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

#keyString

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.

Returns:

  • (String)

    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_userString

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.

Returns:

  • (String)

    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.

Parameters:

  • batch_delete_alerts_request_object (Google::Apis::AlertcenterV1beta1::BatchDeleteAlertsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • batch_undelete_alerts_request_object (Google::Apis::AlertcenterV1beta1::BatchUndeleteAlertsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert this feedback belongs to.

  • alert_feedback_object (Google::Apis::AlertcenterV1beta1::AlertFeedback) (defaults to: nil)
  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert to delete.

  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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}', options)
  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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert to retrieve.

  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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}', options)
  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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert this metadata belongs to.

  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • alert_id (String)

    Required. The alert identifier. The "-" wildcard could be used to represent all alerts.

  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.

  • filter (String) (defaults to: nil)

    Optional. A query string for filtering alert feedback results. For more details, see Query filters and Supported query filter fields.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.

  • filter (String) (defaults to: nil)

    Optional. A query string for filtering alert results. For more details, see Query filters and Supported query filter fields.

  • order_by (String) (defaults to: nil)

    Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using order_by="create_time desc". Currently, supported sorting are create_time asc, create_time desc, update_time desc

  • page_size (Fixnum) (defaults to: nil)

    Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.

  • page_token (String) (defaults to: nil)

    Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert to undelete.

  • undelete_alert_request_object (Google::Apis::AlertcenterV1beta1::UndeleteAlertRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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.

Parameters:

  • settings_object (Google::Apis::AlertcenterV1beta1::Settings) (defaults to: nil)
  • customer_id (String) (defaults to: nil)

    Optional. The unique identifier of the G Suite organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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', options)
  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