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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/alertcenter_v1beta1/service.rb

Overview

Google Workspace Alert Center API

Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.

Examples:

require 'google/apis/alertcenter_v1beta1'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://alertcenter.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AlertCenterService

Returns a new instance of AlertCenterService.



48
49
50
51
52
53
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-alertcenter_v1beta1',
        client_version: Google::Apis::AlertcenterV1beta1::GEM_VERSION)
  @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.

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.



41
42
43
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 41

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.

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.



46
47
48
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 46

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 74

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 104

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 Google Workspace account of the customer the alert is associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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 Google Workspace account of the customer the alert is associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 145

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 Google Workspace account of the customer the alert is associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 183

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 Google Workspace account of the customer the alert metadata is associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 221

def get_alert_metadata(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 Google Workspace account of the customer the alert settings are associated with. The customer_id must/ have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



437
438
439
440
441
442
443
444
445
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 437

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 Google Workspace account of the customer the alert is associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 401

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 Google Workspace account of the customer the alerts are associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 274

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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 313

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 Google Workspace account of the customer the alert settings are associated with. The customer_id must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.

  • 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:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/google/apis/alertcenter_v1beta1/service.rb', line 472

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