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

G Suite Alert Center API to view and manage 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

#initialize ⇒ AlertCenterService

Returns a new instance of AlertCenterService



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

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.

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.



39
40
41
 
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 39

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.



44
45
46
 
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 44

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 a new alert feedback.

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 Google account of the customer the alert's feedback is associated with. This is obfuscated and not the plain customer ID as stored internally. 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:



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

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 will be excluded from the results of a List operation by default, and will be removed from the Alert Center after 30 days. Marking an alert for deletion will have no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion will return NOT_FOUND.

Parameters:

  • alert_id (String) —

    Required. The identifier of the alert to delete.

  • customer_id (String) —

    Optional. The unique identifier of the Google account of the customer the alert is associated with. This is obfuscated and not the plain customer ID as stored internally. 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:



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

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.

  • customer_id (String) —

    Optional. The unique identifier of the Google account of the customer the alert is associated with. This is obfuscated and not the plain customer ID as stored internally. 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:



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

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

#list_alert_feedbacks(alert_id, customer_id: 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. If the alert does not exist returns a NOT_FOUND error.

  • customer_id (String) —

    Optional. The unique identifier of the Google account of the customer the alert is associated with. This is obfuscated and not the plain customer ID as stored internally. 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:



283
284
285
286
287
288
289
290
291
292
 
# File 'generated/google/apis/alertcenter_v1beta1/service.rb', line 283

def list_alert_feedbacks(alert_id, customer_id: 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['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 all the alerts for the current user and application.

Parameters:

  • customer_id (String) —

    Optional. The unique identifier of the Google account of the customer the alerts are associated with. This is obfuscated and not the plain customer ID as stored internally. Inferred from the caller identity if not provided.

  • filter (String) —

    Optional. Query string for filtering alert results. This string must be specified as an expression or list of expressions, using the following grammar:

    Expressions

    An expression has the general form <field> <operator> <value>. A field or value which contains a space or a colon must be enclosed by double quotes.

    Operators

    Operators follow the BNF specification: <equalityOperator> ::= "=" | ":" <relationalOperator> ::= "<" | ">" | "<=" | ">=" Relational operators are defined only for timestamp fields. Equality operators are defined only for string fields.

    Timestamp fields

    The value supplied for a timestamp field must be an RFC 3339 date-time string. Supported timestamp fields are create_time, start_time, and end_time.

    String fields

    The value supplied for a string field may be an arbitrary string.

    Examples

    To query for all alerts created on or after April 5, 2018: create_time >= "2018-04-05T00:00:00Z" To query for all alerts from the source "Gmail phishing": source:"Gmail phishing"

    Joining expressions

    Expressions may be joined to form a more complex query. The BNF specification is: <expressionList> ::= <expression> | <expressionList> <conjunction> <expressionList> | <negation> <expressionList> <conjunction> ::= "AND" | "OR" | "" <negation> ::= "NOT" Using the empty string as a conjunction acts as an implicit AND. The precedence of joining operations, from highest to lowest, is NOT, AND, OR.

    Examples

    To query for all alerts which started in 2017: start_time >= "2017-01-01T00:00:00Z" AND start_time < "2018-01-01T00:00:00Z" To query for all user reported phishing alerts from the source "Gmail phishing": type:"User reported phishing" source:"Gmail phishing"

  • order_by (String) —

    Optional. Sort the list results by a certain order. If not specified results may be returned in arbitrary order. You can sort the results in a 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. Requested page size. Server may return fewer items than requested. If unspecified, server will pick 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:



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

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