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

#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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert this feedback belongs to. Returns a NOT_FOUND error if no such alert.

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

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


244
245
246
247
248
249
250
251
252
253
254
255
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 244

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)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


78
79
80
81
82
83
84
85
86
87
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 78

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.

Parameters:

  • alert_id (String)

    Required. The identifier of the alert to retrieve. Returns a NOT_FOUND error if no such alert.

  • customer_id (String)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


114
115
116
117
118
119
120
121
122
123
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 114

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

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


323
324
325
326
327
328
329
330
331
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 323

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.

Parameters:

  • alert_id (String)

    Required. The alert identifier. The "-" wildcard could be used to represent all alerts. If alert does not exist returns a NOT_FOUND error.

  • customer_id (String)

    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)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


289
290
291
292
293
294
295
296
297
298
299
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 289

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)

    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)

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

  • order_by (String)

    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, only sorting by create_time desc is supported.

  • page_size (Fixnum)

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

  • page_token (String)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 167

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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


206
207
208
209
210
211
212
213
214
215
216
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 206

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

Update the customer-level settings.

Parameters:

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

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


356
357
358
359
360
361
362
363
364
365
366
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 356

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