alertcenter

package
v0.93.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 16, 2022 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package alertcenter provides access to the Google Workspace Alert Center API.

For product documentation, see: https://developers.google.com/admin-sdk/alertcenter/

Creating a client

Usage example: 

import "google.golang.org/api/alertcenter/v1beta1"
...
ctx := context.Background()
alertcenterService, err := alertcenter.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: 

alertcenterService, err := alertcenter.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
alertcenterService, err := alertcenter.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source 
const (
	// See and delete your domain's G Suite alerts, and send alert feedback
	AppsAlertsScope = "https://www.googleapis.com/auth/apps.alerts"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountSuspensionDetails added in v0.53.0 

type AccountSuspensionDetails struct {
	// AbuseReason: The reason why this account is receiving an account
	// suspension warning.
	//
	// Possible values:
	//   "ACCOUNT_SUSPENSION_ABUSE_REASON_UNSPECIFIED" - Abuse reason is
	// unspecified.
	//   "TOS_VIOLATION" - This account is being suspended for a Terms of
	// Service violation.
	//   "SPAM" - This account is being suspended for spam.
	//   "PHISHING" - This account is being suspended for phishing.
	//   "TRAFFIC_PUMPING" - This account is being suspended for
	// artificially boosting traffic to a website.
	//   "FRAUD" - This account is being suspended for fraud.
	//   "NUMBER_HARVESTING" - This account is being suspended for number
	// harvesting.
	//   "PAYMENTS_FRAUD" - This account is being suspended for payments
	// fraud.
	//   "UNWANTED_CONTENT" - This account is being suspended for unwanted
	// content.
	AbuseReason string `json:"abuseReason,omitempty"`

	// ProductName: The name of the product being abused. This is restricted
	// to only the following values: "Gmail" "Google Workspace" "Payments"
	// "Voice" "YouTube" "Other"
	ProductName string `json:"productName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AbuseReason") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AbuseReason") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AccountSuspensionDetails: Details about why an account is receiving an account suspension warning.

func (*AccountSuspensionDetails) MarshalJSON added in v0.53.0 

func (s *AccountSuspensionDetails) MarshalJSON() ([]byte, error)

type AccountSuspensionWarning added in v0.53.0 

type AccountSuspensionWarning struct {
	// AppealWindow: The amount of time remaining to appeal an imminent
	// suspension. After this window has elapsed, the account will be
	// suspended. Only populated if the account suspension is in WARNING
	// state.
	AppealWindow string `json:"appealWindow,omitempty"`

	// State: Account suspension warning state.
	//
	// Possible values:
	//   "ACCOUNT_SUSPENSION_WARNING_STATE_UNSPECIFIED" - State is
	// unspecified.
	//   "WARNING" - Customer is receiving a warning about imminent
	// suspension.
	//   "SUSPENDED" - Customer is being notified that their account has
	// been suspended.
	//   "APPEAL_APPROVED" - Customer is being notified that their
	// suspension appeal was approved.
	//   "APPEAL_SUBMITTED" - Customer has submitted their appeal, which is
	// pending review.
	State string `json:"state,omitempty"`

	// SuspensionDetails: Details about why an account is being suspended.
	SuspensionDetails []*AccountSuspensionDetails `json:"suspensionDetails,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AppealWindow") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppealWindow") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AccountSuspensionWarning: A warning that the customer's account is about to be suspended.

func (*AccountSuspensionWarning) MarshalJSON added in v0.53.0 

func (s *AccountSuspensionWarning) MarshalJSON() ([]byte, error)

type AccountWarning 

type AccountWarning struct {
	// Email: Required. The email of the user that this event belongs to.
	Email string `json:"email,omitempty"`

	// LoginDetails: Optional. Details of the login action associated with
	// the warning event. This is only available for: * Suspicious login *
	// Suspicious login (less secure app) * Suspicious programmatic login *
	// User suspended (suspicious activity)
	LoginDetails *LoginDetails `json:"loginDetails,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AccountWarning: Alerts for user account warning events.

func (*AccountWarning) MarshalJSON 

func (s *AccountWarning) MarshalJSON() ([]byte, error)

type ActionInfo added in v0.41.0 

type ActionInfo struct {
}

ActionInfo: Metadata related to the action.

type ActivityRule added in v0.4.0 

type ActivityRule struct {
	// ActionNames: List of action names associated with the rule threshold.
	ActionNames []string `json:"actionNames,omitempty"`

	// CreateTime: Rule create timestamp.
	CreateTime string `json:"createTime,omitempty"`

	// Description: Description of the rule.
	Description string `json:"description,omitempty"`

	// DisplayName: Alert display name.
	DisplayName string `json:"displayName,omitempty"`

	// Name: Rule name.
	Name string `json:"name,omitempty"`

	// Query: Query that is used to get the data from the associated source.
	Query string `json:"query,omitempty"`

	// SupersededAlerts: List of alert IDs superseded by this alert. It is
	// used to indicate that this alert is essentially extension of
	// superseded alerts and we found the relationship after creating these
	// alerts.
	SupersededAlerts []string `json:"supersededAlerts,omitempty"`

	// SupersedingAlert: Alert ID superseding this alert. It is used to
	// indicate that superseding alert is essentially extension of this
	// alert and we found the relationship after creating both alerts.
	SupersedingAlert string `json:"supersedingAlert,omitempty"`

	// Threshold: Alert threshold is for example “COUNT > 5”.
	Threshold string `json:"threshold,omitempty"`

	// TriggerSource: The trigger sources for this rule. * GMAIL_EVENTS *
	// DEVICE_EVENTS * USER_EVENTS
	TriggerSource string `json:"triggerSource,omitempty"`

	// UpdateTime: The timestamp of the last update to the rule.
	UpdateTime string `json:"updateTime,omitempty"`

	// WindowSize: Rule window size. Possible values are 1 hour or 24 hours.
	WindowSize string `json:"windowSize,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ActionNames") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ActionNames") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ActivityRule: Alerts from Google Workspace Security Center rules service configured by an admin.

func (*ActivityRule) MarshalJSON added in v0.4.0 

func (s *ActivityRule) MarshalJSON() ([]byte, error)

type Alert 

type Alert struct {
	// AlertId: Output only. The unique identifier for the alert.
	AlertId string `json:"alertId,omitempty"`

	// CreateTime: Output only. The time this alert was created.
	CreateTime string `json:"createTime,omitempty"`

	// CustomerId: Output only. The unique identifier of the Google account
	// of the customer.
	CustomerId string `json:"customerId,omitempty"`

	// Data: Optional. The data associated with this alert, for example
	// google.apps.alertcenter.type.DeviceCompromised.
	Data googleapi.RawMessage `json:"data,omitempty"`

	// Deleted: Output only. `True` if this alert is marked for deletion.
	Deleted bool `json:"deleted,omitempty"`

	// EndTime: Optional. The time the event that caused this alert ceased
	// being active. If provided, the end time must not be earlier than the
	// start time. If not provided, it indicates an ongoing alert.
	EndTime string `json:"endTime,omitempty"`

	// Etag: Optional. `etag` is used for optimistic concurrency control as
	// a way to help prevent simultaneous updates of an alert from
	// overwriting each other. It is strongly suggested that systems make
	// use of the `etag` in the read-modify-write cycle to perform alert
	// updates in order to avoid race conditions: An `etag` is returned in
	// the response which contains alerts, and systems are expected to put
	// that etag in the request to update alert to ensure that their change
	// will be applied to the same version of the alert. If no `etag` is
	// provided in the call to update alert, then the existing alert is
	// overwritten blindly.
	Etag string `json:"etag,omitempty"`

	// Metadata: Output only. The metadata associated with this alert.
	Metadata *AlertMetadata `json:"metadata,omitempty"`

	// SecurityInvestigationToolLink: Output only. An optional Security
	// Investigation Tool (https://support.google.com/a/answer/7575955)
	// query for this alert.
	SecurityInvestigationToolLink string `json:"securityInvestigationToolLink,omitempty"`

	// Source: Required. A unique identifier for the system that reported
	// the alert. This is output only after alert is created. Supported
	// sources are any of the following: * Google Operations * Mobile device
	// management * Gmail phishing * Data Loss Prevention * Domain wide
	// takeout * State sponsored attack * Google identity * Apps outage
	Source string `json:"source,omitempty"`

	// StartTime: Required. The time the event that caused this alert was
	// started or detected.
	StartTime string `json:"startTime,omitempty"`

	// Type: Required. The type of the alert. This is output only after
	// alert is created. For a list of available alert types see Google
	// Workspace Alert types
	// (https://developers.google.com/admin-sdk/alertcenter/reference/alert-types).
	Type string `json:"type,omitempty"`

	// UpdateTime: Output only. The time this alert was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AlertId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Alert: An alert affecting a customer.

func (*Alert) MarshalJSON 

func (s *Alert) MarshalJSON() ([]byte, error)

type AlertFeedback 

type AlertFeedback struct {
	// AlertId: Output only. The alert identifier.
	AlertId string `json:"alertId,omitempty"`

	// CreateTime: Output only. The time this feedback was created.
	CreateTime string `json:"createTime,omitempty"`

	// CustomerId: Output only. The unique identifier of the Google account
	// of the customer.
	CustomerId string `json:"customerId,omitempty"`

	// Email: Output only. The email of the user that provided the feedback.
	Email string `json:"email,omitempty"`

	// FeedbackId: Output only. The unique identifier for the feedback.
	FeedbackId string `json:"feedbackId,omitempty"`

	// Type: Required. The type of the feedback.
	//
	// Possible values:
	//   "ALERT_FEEDBACK_TYPE_UNSPECIFIED" - The feedback type is not
	// specified.
	//   "NOT_USEFUL" - The alert report is not useful.
	//   "SOMEWHAT_USEFUL" - The alert report is somewhat useful.
	//   "VERY_USEFUL" - The alert report is very useful.
	Type string `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AlertId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AlertFeedback: A customer feedback about an alert.

func (*AlertFeedback) MarshalJSON 

func (s *AlertFeedback) MarshalJSON() ([]byte, error)

type AlertMetadata added in v0.10.0 

type AlertMetadata struct {
	// AlertId: Output only. The alert identifier.
	AlertId string `json:"alertId,omitempty"`

	// Assignee: The email address of the user assigned to the alert.
	Assignee string `json:"assignee,omitempty"`

	// CustomerId: Output only. The unique identifier of the Google account
	// of the customer.
	CustomerId string `json:"customerId,omitempty"`

	// Etag: Optional. `etag` is used for optimistic concurrency control as
	// a way to help prevent simultaneous updates of an alert metadata from
	// overwriting each other. It is strongly suggested that systems make
	// use of the `etag` in the read-modify-write cycle to perform metadata
	// updates in order to avoid race conditions: An `etag` is returned in
	// the response which contains alert metadata, and systems are expected
	// to put that etag in the request to update alert metadata to ensure
	// that their change will be applied to the same version of the alert
	// metadata. If no `etag` is provided in the call to update alert
	// metadata, then the existing alert metadata is overwritten blindly.
	Etag string `json:"etag,omitempty"`

	// Severity: The severity value of the alert. Alert Center will set this
	// field at alert creation time, default's to an empty string when it
	// could not be determined. The supported values for update actions on
	// this field are the following: * HIGH * MEDIUM * LOW
	Severity string `json:"severity,omitempty"`

	// Status: The current status of the alert. The supported values are the
	// following: * NOT_STARTED * IN_PROGRESS * CLOSED
	Status string `json:"status,omitempty"`

	// UpdateTime: Output only. The time this metadata was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AlertId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AlertMetadata: An alert metadata.

func (*AlertMetadata) MarshalJSON added in v0.10.0 

func (s *AlertMetadata) MarshalJSON() ([]byte, error)

type AlertsBatchDeleteCall added in v0.10.0 

type AlertsBatchDeleteCall struct {
	// contains filtered or unexported fields
}

func (*AlertsBatchDeleteCall) Context added in v0.10.0 

func (c *AlertsBatchDeleteCall) Context(ctx context.Context) *AlertsBatchDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsBatchDeleteCall) Do added in v0.10.0 

func (c *AlertsBatchDeleteCall) Do(opts ...googleapi.CallOption) (*BatchDeleteAlertsResponse, error)

Do executes the "alertcenter.alerts.batchDelete" call. Exactly one of *BatchDeleteAlertsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchDeleteAlertsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsBatchDeleteCall) Fields added in v0.10.0 

func (c *AlertsBatchDeleteCall) Fields(s ...googleapi.Field) *AlertsBatchDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsBatchDeleteCall) Header added in v0.10.0 

func (c *AlertsBatchDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AlertsBatchUndeleteCall added in v0.10.0 

type AlertsBatchUndeleteCall struct {
	// contains filtered or unexported fields
}

func (*AlertsBatchUndeleteCall) Context added in v0.10.0 

func (c *AlertsBatchUndeleteCall) Context(ctx context.Context) *AlertsBatchUndeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsBatchUndeleteCall) Do added in v0.10.0 

func (c *AlertsBatchUndeleteCall) Do(opts ...googleapi.CallOption) (*BatchUndeleteAlertsResponse, error)

Do executes the "alertcenter.alerts.batchUndelete" call. Exactly one of *BatchUndeleteAlertsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchUndeleteAlertsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsBatchUndeleteCall) Fields added in v0.10.0 

func (c *AlertsBatchUndeleteCall) Fields(s ...googleapi.Field) *AlertsBatchUndeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsBatchUndeleteCall) Header added in v0.10.0 

func (c *AlertsBatchUndeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AlertsDeleteCall 

type AlertsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*AlertsDeleteCall) Context 

func (c *AlertsDeleteCall) Context(ctx context.Context) *AlertsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsDeleteCall) CustomerId 

func (c *AlertsDeleteCall) CustomerId(customerId string) *AlertsDeleteCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

func (*AlertsDeleteCall) Do 

func (c *AlertsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "alertcenter.alerts.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsDeleteCall) Fields 

func (c *AlertsDeleteCall) Fields(s ...googleapi.Field) *AlertsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsDeleteCall) Header 

func (c *AlertsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AlertsFeedbackCreateCall 

type AlertsFeedbackCreateCall struct {
	// contains filtered or unexported fields
}

func (*AlertsFeedbackCreateCall) Context 

func (c *AlertsFeedbackCreateCall) Context(ctx context.Context) *AlertsFeedbackCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsFeedbackCreateCall) CustomerId 

func (c *AlertsFeedbackCreateCall) CustomerId(customerId string) *AlertsFeedbackCreateCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

func (*AlertsFeedbackCreateCall) Do 

func (c *AlertsFeedbackCreateCall) Do(opts ...googleapi.CallOption) (*AlertFeedback, error)

Do executes the "alertcenter.alerts.feedback.create" call. Exactly one of *AlertFeedback or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AlertFeedback.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsFeedbackCreateCall) Fields 

func (c *AlertsFeedbackCreateCall) Fields(s ...googleapi.Field) *AlertsFeedbackCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsFeedbackCreateCall) Header 

func (c *AlertsFeedbackCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AlertsFeedbackListCall 

type AlertsFeedbackListCall struct {
	// contains filtered or unexported fields
}

func (*AlertsFeedbackListCall) Context 

func (c *AlertsFeedbackListCall) Context(ctx context.Context) *AlertsFeedbackListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsFeedbackListCall) CustomerId 

func (c *AlertsFeedbackListCall) CustomerId(customerId string) *AlertsFeedbackListCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided.

func (*AlertsFeedbackListCall) Do 

func (c *AlertsFeedbackListCall) Do(opts ...googleapi.CallOption) (*ListAlertFeedbackResponse, error)

Do executes the "alertcenter.alerts.feedback.list" call. Exactly one of *ListAlertFeedbackResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAlertFeedbackResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsFeedbackListCall) Fields 

func (c *AlertsFeedbackListCall) Fields(s ...googleapi.Field) *AlertsFeedbackListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsFeedbackListCall) Filter 

func (c *AlertsFeedbackListCall) Filter(filter string) *AlertsFeedbackListCall

Filter sets the optional parameter "filter": A query string for filtering alert feedback results. For more details, see Query filters (https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and Supported query filter fields (https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list).

func (*AlertsFeedbackListCall) Header 

func (c *AlertsFeedbackListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AlertsFeedbackListCall) IfNoneMatch 

func (c *AlertsFeedbackListCall) IfNoneMatch(entityTag string) *AlertsFeedbackListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AlertsFeedbackService 

type AlertsFeedbackService struct {
	// contains filtered or unexported fields
}

func NewAlertsFeedbackService 

func NewAlertsFeedbackService(s *Service) *AlertsFeedbackService

func (*AlertsFeedbackService) Create 

func (r *AlertsFeedbackService) Create(alertId string, alertfeedback *AlertFeedback) *AlertsFeedbackCreateCall

Create: 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.

- alertId: The identifier of the alert this feedback belongs to.

func (*AlertsFeedbackService) List 

func (r *AlertsFeedbackService) List(alertId string) *AlertsFeedbackListCall

List: Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns `NOT_FOUND` error.

  • alertId: The alert identifier. The "-" wildcard could be used to represent all alerts.

type AlertsGetCall 

type AlertsGetCall struct {
	// contains filtered or unexported fields
}

func (*AlertsGetCall) Context 

func (c *AlertsGetCall) Context(ctx context.Context) *AlertsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsGetCall) CustomerId 

func (c *AlertsGetCall) CustomerId(customerId string) *AlertsGetCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.

func (*AlertsGetCall) Do 

func (c *AlertsGetCall) Do(opts ...googleapi.CallOption) (*Alert, error)

Do executes the "alertcenter.alerts.get" call. Exactly one of *Alert or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Alert.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsGetCall) Fields 

func (c *AlertsGetCall) Fields(s ...googleapi.Field) *AlertsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsGetCall) Header 

func (c *AlertsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AlertsGetCall) IfNoneMatch 

func (c *AlertsGetCall) IfNoneMatch(entityTag string) *AlertsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AlertsGetMetadataCall added in v0.10.0 

type AlertsGetMetadataCall struct {
	// contains filtered or unexported fields
}

func (*AlertsGetMetadataCall) Context added in v0.10.0 

func (c *AlertsGetMetadataCall) Context(ctx context.Context) *AlertsGetMetadataCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsGetMetadataCall) CustomerId added in v0.10.0 

func (c *AlertsGetMetadataCall) CustomerId(customerId string) *AlertsGetMetadataCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert metadata is associated with. Inferred from the caller identity if not provided.

func (*AlertsGetMetadataCall) Do added in v0.10.0 

func (c *AlertsGetMetadataCall) Do(opts ...googleapi.CallOption) (*AlertMetadata, error)

Do executes the "alertcenter.alerts.getMetadata" call. Exactly one of *AlertMetadata or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AlertMetadata.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsGetMetadataCall) Fields added in v0.10.0 

func (c *AlertsGetMetadataCall) Fields(s ...googleapi.Field) *AlertsGetMetadataCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsGetMetadataCall) Header added in v0.10.0 

func (c *AlertsGetMetadataCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AlertsGetMetadataCall) IfNoneMatch added in v0.10.0 

func (c *AlertsGetMetadataCall) IfNoneMatch(entityTag string) *AlertsGetMetadataCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AlertsListCall 

type AlertsListCall struct {
	// contains filtered or unexported fields
}

func (*AlertsListCall) Context 

func (c *AlertsListCall) Context(ctx context.Context) *AlertsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsListCall) CustomerId 

func (c *AlertsListCall) CustomerId(customerId string) *AlertsListCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided.

func (*AlertsListCall) Do 

func (c *AlertsListCall) Do(opts ...googleapi.CallOption) (*ListAlertsResponse, error)

Do executes the "alertcenter.alerts.list" call. Exactly one of *ListAlertsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAlertsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsListCall) Fields 

func (c *AlertsListCall) Fields(s ...googleapi.Field) *AlertsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsListCall) Filter 

func (c *AlertsListCall) Filter(filter string) *AlertsListCall

Filter sets the optional parameter "filter": A query string for filtering alert results. For more details, see Query filters (https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and Supported query filter fields (https://developers.google.com/admin-sdk/alertcenter/reference/filter-fields#alerts.list).

func (*AlertsListCall) Header 

func (c *AlertsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AlertsListCall) IfNoneMatch 

func (c *AlertsListCall) IfNoneMatch(entityTag string) *AlertsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AlertsListCall) OrderBy 

func (c *AlertsListCall) OrderBy(orderBy string) *AlertsListCall

OrderBy sets the optional parameter "orderBy": 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`

func (*AlertsListCall) PageSize 

func (c *AlertsListCall) PageSize(pageSize int64) *AlertsListCall

PageSize sets the optional parameter "pageSize": The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.

func (*AlertsListCall) PageToken 

func (c *AlertsListCall) PageToken(pageToken string) *AlertsListCall

PageToken sets the optional parameter "pageToken": 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.

func (*AlertsListCall) Pages 

func (c *AlertsListCall) Pages(ctx context.Context, f func(*ListAlertsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type AlertsService 

type AlertsService struct {
	Feedback *AlertsFeedbackService
	// contains filtered or unexported fields
}

func NewAlertsService 

func NewAlertsService(s *Service) *AlertsService

func (*AlertsService) BatchDelete added in v0.10.0 

func (r *AlertsService) BatchDelete(batchdeletealertsrequest *BatchDeleteAlertsRequest) *AlertsBatchDeleteCall

BatchDelete: Performs batch delete operation on alerts.

func (*AlertsService) BatchUndelete added in v0.10.0 

func (r *AlertsService) BatchUndelete(batchundeletealertsrequest *BatchUndeleteAlertsRequest) *AlertsBatchUndeleteCall

BatchUndelete: Performs batch undelete operation on alerts.

func (*AlertsService) Delete 

func (r *AlertsService) Delete(alertId string) *AlertsDeleteCall

Delete: 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.

- alertId: The identifier of the alert to delete.

func (*AlertsService) Get 

func (r *AlertsService) Get(alertId string) *AlertsGetCall

Get: Gets the specified alert. Attempting to get a nonexistent alert returns `NOT_FOUND` error.

- alertId: The identifier of the alert to retrieve.

func (*AlertsService) GetMetadata added in v0.10.0 

func (r *AlertsService) GetMetadata(alertId string) *AlertsGetMetadataCall

GetMetadata: Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error.

- alertId: The identifier of the alert this metadata belongs to.

func (*AlertsService) List 

func (r *AlertsService) List() *AlertsListCall

List: Lists the alerts.

func (*AlertsService) Undelete 

func (r *AlertsService) Undelete(alertId string, undeletealertrequest *UndeleteAlertRequest) *AlertsUndeleteCall

Undelete: 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.

- alertId: The identifier of the alert to undelete.

type AlertsUndeleteCall 

type AlertsUndeleteCall struct {
	// contains filtered or unexported fields
}

func (*AlertsUndeleteCall) Context 

func (c *AlertsUndeleteCall) Context(ctx context.Context) *AlertsUndeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AlertsUndeleteCall) Do 

func (c *AlertsUndeleteCall) Do(opts ...googleapi.CallOption) (*Alert, error)

Do executes the "alertcenter.alerts.undelete" call. Exactly one of *Alert or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Alert.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AlertsUndeleteCall) Fields 

func (c *AlertsUndeleteCall) Fields(s ...googleapi.Field) *AlertsUndeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AlertsUndeleteCall) Header 

func (c *AlertsUndeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ApnsCertificateExpirationInfo added in v0.89.0 

type ApnsCertificateExpirationInfo struct {
	// AppleId: The Apple ID used for the certificate, may be blank if
	// admins did not enter it.
	AppleId string `json:"appleId,omitempty"`

	// ExpirationTime: The expiration date of the APNS Certificate.
	ExpirationTime string `json:"expirationTime,omitempty"`

	// Uid: The UID for the certificate.
	Uid string `json:"uid,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AppleId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppleId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ApnsCertificateExpirationInfo: The explanation message associated with ApnsCertificationExpiring and ApnsCertificationExpired alerts.

func (*ApnsCertificateExpirationInfo) MarshalJSON added in v0.89.0 

func (s *ApnsCertificateExpirationInfo) MarshalJSON() ([]byte, error)

type AppMakerSqlSetupNotification added in v0.11.0 

type AppMakerSqlSetupNotification struct {
	// RequestInfo: List of applications with requests for default SQL set
	// up.
	RequestInfo []*RequestInfo `json:"requestInfo,omitempty"`

	// ForceSendFields is a list of field names (e.g. "RequestInfo") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RequestInfo") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AppMakerSqlSetupNotification: Alerts from App Maker to notify admins to set up default SQL instance.

func (*AppMakerSqlSetupNotification) MarshalJSON added in v0.11.0 

func (s *AppMakerSqlSetupNotification) MarshalJSON() ([]byte, error)

type AppSettingsChanged added in v0.47.0 

type AppSettingsChanged struct {
	// AlertDetails: Any other associated alert details, for example,
	// AlertConfiguration.
	AlertDetails string `json:"alertDetails,omitempty"`

	// Name: Rule name
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AlertDetails") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertDetails") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AppSettingsChanged: Alerts from AppSettingsChanged bucket Rules configured by Admin which contain the below rules. Calendar settings changed Drive settings changed Email settings changed Mobile settings changed

func (*AppSettingsChanged) MarshalJSON added in v0.47.0 

func (s *AppSettingsChanged) MarshalJSON() ([]byte, error)

type AppsOutage added in v0.52.0 

type AppsOutage struct {
	// DashboardUri: Link to the outage event in Google Workspace Status
	// Dashboard
	DashboardUri string `json:"dashboardUri,omitempty"`

	// IncidentTrackingId: Incident tracking ID.
	IncidentTrackingId string `json:"incidentTrackingId,omitempty"`

	// MergeInfo: Indicates new alert details under which the outage is
	// communicated. Only populated when Status is MERGED.
	MergeInfo *MergeInfo `json:"mergeInfo,omitempty"`

	// NextUpdateTime: Timestamp by which the next update is expected to
	// arrive.
	NextUpdateTime string `json:"nextUpdateTime,omitempty"`

	// Products: List of products impacted by the outage.
	Products []string `json:"products,omitempty"`

	// ResolutionTime: Timestamp when the outage is expected to be resolved,
	// or has confirmed resolution. Provided only when known.
	ResolutionTime string `json:"resolutionTime,omitempty"`

	// Status: Current outage status.
	//
	// Possible values:
	//   "STATUS_UNSPECIFIED" - Status is unspecified.
	//   "NEW" - The incident has just been reported.
	//   "ONGOING" - The incident is ongoing.
	//   "RESOLVED" - The incident has been resolved.
	//   "FALSE_POSITIVE" - Further assessment indicated no customer impact.
	//   "PARTIALLY_RESOLVED" - The incident has been partially resolved.
	//   "MERGED" - The incident was merged into a parent.
	//   "DOWNGRADED" - The incident has lower impact than initially
	// anticipated.
	Status string `json:"status,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DashboardUri") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DashboardUri") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AppsOutage: An outage incident reported for a Google Workspace service.

func (*AppsOutage) MarshalJSON added in v0.52.0 

func (s *AppsOutage) MarshalJSON() ([]byte, error)

type Attachment 

type Attachment struct {
	// Csv: A CSV file attachment.
	Csv *Csv `json:"csv,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Csv") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Csv") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Attachment: Attachment with application-specific information about an alert.

func (*Attachment) MarshalJSON 

func (s *Attachment) MarshalJSON() ([]byte, error)

type BadWhitelist 

type BadWhitelist struct {
	// DomainId: The domain ID.
	DomainId *DomainId `json:"domainId,omitempty"`

	// MaliciousEntity: The entity whose actions triggered a Gmail phishing
	// alert.
	MaliciousEntity *MaliciousEntity `json:"maliciousEntity,omitempty"`

	// Messages: The list of messages contained by this alert.
	Messages []*GmailMessageInfo `json:"messages,omitempty"`

	// SourceIp: The source IP address of the malicious email, for example,
	// `127.0.0.1`.
	SourceIp string `json:"sourceIp,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DomainId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DomainId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BadWhitelist: Alert for setting the domain or IP that malicious email comes from as whitelisted domain or IP in Gmail advanced settings.

func (*BadWhitelist) MarshalJSON 

func (s *BadWhitelist) MarshalJSON() ([]byte, error)

type BatchDeleteAlertsRequest added in v0.10.0 

type BatchDeleteAlertsRequest struct {
	// AlertId: Required. list of alert IDs.
	AlertId []string `json:"alertId,omitempty"`

	// CustomerId: Optional. The unique identifier of the Google Workspace
	// organization account of the customer the alerts are associated with.
	CustomerId string `json:"customerId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AlertId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchDeleteAlertsRequest: A request to perform batch delete on alerts.

func (*BatchDeleteAlertsRequest) MarshalJSON added in v0.10.0 

func (s *BatchDeleteAlertsRequest) MarshalJSON() ([]byte, error)

type BatchDeleteAlertsResponse added in v0.10.0 

type BatchDeleteAlertsResponse struct {
	// FailedAlertStatus: The status details for each failed alert_id.
	FailedAlertStatus map[string]Status `json:"failedAlertStatus,omitempty"`

	// SuccessAlertIds: The successful list of alert IDs.
	SuccessAlertIds []string `json:"successAlertIds,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "FailedAlertStatus")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FailedAlertStatus") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

BatchDeleteAlertsResponse: Response to batch delete operation on alerts.

func (*BatchDeleteAlertsResponse) MarshalJSON added in v0.10.0 

func (s *BatchDeleteAlertsResponse) MarshalJSON() ([]byte, error)

type BatchUndeleteAlertsRequest added in v0.10.0 

type BatchUndeleteAlertsRequest struct {
	// AlertId: Required. list of alert IDs.
	AlertId []string `json:"alertId,omitempty"`

	// CustomerId: Optional. The unique identifier of the Google Workspace
	// organization account of the customer the alerts are associated with.
	CustomerId string `json:"customerId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AlertId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchUndeleteAlertsRequest: A request to perform batch undelete on alerts.

func (*BatchUndeleteAlertsRequest) MarshalJSON added in v0.10.0 

func (s *BatchUndeleteAlertsRequest) MarshalJSON() ([]byte, error)

type BatchUndeleteAlertsResponse added in v0.10.0 

type BatchUndeleteAlertsResponse struct {
	// FailedAlertStatus: The status details for each failed alert_id.
	FailedAlertStatus map[string]Status `json:"failedAlertStatus,omitempty"`

	// SuccessAlertIds: The successful list of alert IDs.
	SuccessAlertIds []string `json:"successAlertIds,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "FailedAlertStatus")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FailedAlertStatus") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

BatchUndeleteAlertsResponse: Response to batch undelete operation on alerts.

func (*BatchUndeleteAlertsResponse) MarshalJSON added in v0.10.0 

func (s *BatchUndeleteAlertsResponse) MarshalJSON() ([]byte, error)

type CloudPubsubTopic 

type CloudPubsubTopic struct {
	// PayloadFormat: Optional. The format of the payload that would be
	// sent. If not specified the format will be JSON.
	//
	// Possible values:
	//   "PAYLOAD_FORMAT_UNSPECIFIED" - Payload format is not specified
	// (will use JSON as default).
	//   "JSON" - Use JSON.
	PayloadFormat string `json:"payloadFormat,omitempty"`

	// TopicName: The `name` field of a Cloud Pubsub [Topic]
	// (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
	TopicName string `json:"topicName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PayloadFormat") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PayloadFormat") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CloudPubsubTopic: A reference to a Cloud Pubsub topic. To register for notifications, the owner of the topic must grant `alerts-api-push-notifications@system.gserviceaccount.com` the `projects.topics.publish` permission.

func (*CloudPubsubTopic) MarshalJSON 

func (s *CloudPubsubTopic) MarshalJSON() ([]byte, error)

type Csv 

type Csv struct {
	// DataRows: The list of data rows in a CSV file, as string arrays
	// rather than as a single comma-separated string.
	DataRows []*CsvRow `json:"dataRows,omitempty"`

	// Headers: The list of headers for data columns in a CSV file.
	Headers []string `json:"headers,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataRows") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataRows") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Csv: A representation of a CSV file attachment, as a list of column headers and a list of data rows.

func (*Csv) MarshalJSON 

func (s *Csv) MarshalJSON() ([]byte, error)

type CsvRow 

type CsvRow struct {
	// Entries: The data entries in a CSV file row, as a string array rather
	// than a single comma-separated string.
	Entries []string `json:"entries,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Entries") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Entries") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CsvRow: A representation of a single data row in a CSV file.

func (*CsvRow) MarshalJSON 

func (s *CsvRow) MarshalJSON() ([]byte, error)

type DeviceCompromised 

type DeviceCompromised struct {
	// Email: The email of the user this alert was created for.
	Email string `json:"email,omitempty"`

	// Events: Required. The list of security events.
	Events []*DeviceCompromisedSecurityDetail `json:"events,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DeviceCompromised: A mobile device compromised alert. Derived from audit logs.

func (*DeviceCompromised) MarshalJSON 

func (s *DeviceCompromised) MarshalJSON() ([]byte, error)

type DeviceCompromisedSecurityDetail 

type DeviceCompromisedSecurityDetail struct {
	// DeviceCompromisedState: The device compromised state. Possible values
	// are "Compromised" or "Not Compromised".
	DeviceCompromisedState string `json:"deviceCompromisedState,omitempty"`

	// DeviceId: Required. The device ID.
	DeviceId string `json:"deviceId,omitempty"`

	// DeviceModel: The model of the device.
	DeviceModel string `json:"deviceModel,omitempty"`

	// DeviceType: The type of the device.
	DeviceType string `json:"deviceType,omitempty"`

	// IosVendorId: Required for iOS, empty for others.
	IosVendorId string `json:"iosVendorId,omitempty"`

	// ResourceId: The device resource ID.
	ResourceId string `json:"resourceId,omitempty"`

	// SerialNumber: The serial number of the device.
	SerialNumber string `json:"serialNumber,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DeviceCompromisedState") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceCompromisedState")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DeviceCompromisedSecurityDetail: Detailed information of a single MDM device compromised event.

func (*DeviceCompromisedSecurityDetail) MarshalJSON 

func (s *DeviceCompromisedSecurityDetail) MarshalJSON() ([]byte, error)

type DlpRuleViolation added in v0.17.0 

type DlpRuleViolation struct {
	// RuleViolationInfo: Details about the violated DLP rule. Admins can
	// use the predefined detectors provided by Google Cloud DLP
	// https://cloud.google.com/dlp/ when setting up a DLP rule. Matched
	// Cloud DLP detectors in this violation if any will be captured in the
	// MatchInfo.predefined_detector.
	RuleViolationInfo *RuleViolationInfo `json:"ruleViolationInfo,omitempty"`

	// ForceSendFields is a list of field names (e.g. "RuleViolationInfo")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RuleViolationInfo") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DlpRuleViolation: Alerts that get triggered on violations of Data Loss Prevention (DLP) rules.

func (*DlpRuleViolation) MarshalJSON added in v0.17.0 

func (s *DlpRuleViolation) MarshalJSON() ([]byte, error)

type DomainId 

type DomainId struct {
	// CustomerPrimaryDomain: The primary domain for the customer.
	CustomerPrimaryDomain string `json:"customerPrimaryDomain,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "CustomerPrimaryDomain") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CustomerPrimaryDomain") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DomainId: Domain ID of Gmail phishing alerts.

func (*DomainId) MarshalJSON 

func (s *DomainId) MarshalJSON() ([]byte, error)

type DomainWideTakeoutInitiated 

type DomainWideTakeoutInitiated struct {
	// Email: The email of the admin who initiated the takeout.
	Email string `json:"email,omitempty"`

	// TakeoutRequestId: The takeout request ID.
	TakeoutRequestId string `json:"takeoutRequestId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DomainWideTakeoutInitiated: A takeout operation for the entire domain was initiated by an admin. Derived from audit logs.

func (*DomainWideTakeoutInitiated) MarshalJSON 

func (s *DomainWideTakeoutInitiated) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type GmailMessageInfo 

type GmailMessageInfo struct {
	// AttachmentsSha256Hash: The `SHA256` hash of email's attachment and
	// all MIME parts.
	AttachmentsSha256Hash []string `json:"attachmentsSha256Hash,omitempty"`

	// Date: The date of the event related to this email.
	Date string `json:"date,omitempty"`

	// Md5HashMessageBody: The hash of the message body text.
	Md5HashMessageBody string `json:"md5HashMessageBody,omitempty"`

	// Md5HashSubject: The MD5 Hash of email's subject (only available for
	// reported emails).
	Md5HashSubject string `json:"md5HashSubject,omitempty"`

	// MessageBodySnippet: The snippet of the message body text (only
	// available for reported emails).
	MessageBodySnippet string `json:"messageBodySnippet,omitempty"`

	// MessageId: The message ID.
	MessageId string `json:"messageId,omitempty"`

	// Recipient: The recipient of this email.
	Recipient string `json:"recipient,omitempty"`

	// SubjectText: The email subject text (only available for reported
	// emails).
	SubjectText string `json:"subjectText,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AttachmentsSha256Hash") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AttachmentsSha256Hash") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GmailMessageInfo: Details of a message in phishing spike alert.

func (*GmailMessageInfo) MarshalJSON 

func (s *GmailMessageInfo) MarshalJSON() ([]byte, error)

type GoogleOperations 

type GoogleOperations struct {
	// AffectedUserEmails: The list of emails which correspond to the users
	// directly affected by the incident.
	AffectedUserEmails []string `json:"affectedUserEmails,omitempty"`

	// AttachmentData: Optional. Application-specific data for an incident,
	// provided when the Google Workspace application which reported the
	// incident cannot be completely restored to a valid state.
	AttachmentData *Attachment `json:"attachmentData,omitempty"`

	// Description: A detailed, freeform incident description.
	Description string `json:"description,omitempty"`

	// Domain: Customer domain for email template personalization.
	Domain string `json:"domain,omitempty"`

	// Header: A header to display above the incident message. Typically
	// used to attach a localized notice on the timeline for followup comms
	// translations.
	Header string `json:"header,omitempty"`

	// Title: A one-line incident description.
	Title string `json:"title,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AffectedUserEmails")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AffectedUserEmails") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleOperations: An incident reported by Google Operations for a Google Workspace application.

func (*GoogleOperations) MarshalJSON 

func (s *GoogleOperations) MarshalJSON() ([]byte, error)

type ListAlertFeedbackResponse 

type ListAlertFeedbackResponse struct {
	// Feedback: The list of alert feedback. Feedback entries for each alert
	// are ordered by creation time descending.
	Feedback []*AlertFeedback `json:"feedback,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Feedback") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Feedback") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListAlertFeedbackResponse: Response message for an alert feedback listing request.

func (*ListAlertFeedbackResponse) MarshalJSON 

func (s *ListAlertFeedbackResponse) MarshalJSON() ([]byte, error)

type ListAlertsResponse 

type ListAlertsResponse struct {
	// Alerts: The list of alerts.
	Alerts []*Alert `json:"alerts,omitempty"`

	// NextPageToken: The token for the next page. If not empty, indicates
	// that there may be more alerts that match the listing request; this
	// value can be used in a subsequent ListAlertsRequest to get alerts
	// continuing from last result of the current list call.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Alerts") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Alerts") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListAlertsResponse: Response message for an alert listing request.

func (*ListAlertsResponse) MarshalJSON 

func (s *ListAlertsResponse) MarshalJSON() ([]byte, error)

type LoginDetails 

type LoginDetails struct {
	// IpAddress: Optional. The human-readable IP address (for example,
	// `11.22.33.44`) that is associated with the warning event.
	IpAddress string `json:"ipAddress,omitempty"`

	// LoginTime: Optional. The successful login time that is associated
	// with the warning event. This isn't present for blocked login
	// attempts.
	LoginTime string `json:"loginTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IpAddress") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IpAddress") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LoginDetails: The details of the login action.

func (*LoginDetails) MarshalJSON 

func (s *LoginDetails) MarshalJSON() ([]byte, error)

type MailPhishing 

type MailPhishing struct {
	// DomainId: The domain ID.
	DomainId *DomainId `json:"domainId,omitempty"`

	// IsInternal: If `true`, the email originated from within the
	// organization.
	IsInternal bool `json:"isInternal,omitempty"`

	// MaliciousEntity: The entity whose actions triggered a Gmail phishing
	// alert.
	MaliciousEntity *MaliciousEntity `json:"maliciousEntity,omitempty"`

	// Messages: The list of messages contained by this alert.
	Messages []*GmailMessageInfo `json:"messages,omitempty"`

	// SystemActionType: System actions on the messages.
	//
	// Possible values:
	//   "SYSTEM_ACTION_TYPE_UNSPECIFIED" - System action is unspecified.
	//   "NO_OPERATION" - No operation.
	//   "REMOVED_FROM_INBOX" - Messages were removed from the inbox.
	SystemActionType string `json:"systemActionType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DomainId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DomainId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MailPhishing: Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification * Gmail potential employee spoofing

func (*MailPhishing) MarshalJSON 

func (s *MailPhishing) MarshalJSON() ([]byte, error)

type MaliciousEntity 

type MaliciousEntity struct {
	// DisplayName: The header from display name.
	DisplayName string `json:"displayName,omitempty"`

	// Entity: The actor who triggered a gmail phishing alert.
	Entity *User `json:"entity,omitempty"`

	// FromHeader: The sender email address.
	FromHeader string `json:"fromHeader,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MaliciousEntity: Entity whose actions triggered a Gmail phishing alert.

func (*MaliciousEntity) MarshalJSON 

func (s *MaliciousEntity) MarshalJSON() ([]byte, error)

type MandatoryServiceAnnouncement added in v0.72.0 

type MandatoryServiceAnnouncement struct {
	// Description: Detailed, freeform text describing the announcement
	Description string `json:"description,omitempty"`

	// Title: One line summary of the announcement
	Title string `json:"title,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MandatoryServiceAnnouncement: Alert Created by the MSA team for communications necessary for continued use of Google Workspace Products.

func (*MandatoryServiceAnnouncement) MarshalJSON added in v0.72.0 

func (s *MandatoryServiceAnnouncement) MarshalJSON() ([]byte, error)

type MatchInfo added in v0.17.0 

type MatchInfo struct {
	// PredefinedDetector: For matched detector predefined by Google.
	PredefinedDetector *PredefinedDetectorInfo `json:"predefinedDetector,omitempty"`

	// UserDefinedDetector: For matched detector defined by administrators.
	UserDefinedDetector *UserDefinedDetectorInfo `json:"userDefinedDetector,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PredefinedDetector")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PredefinedDetector") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

MatchInfo: Proto that contains match information from the condition part of the rule.

func (*MatchInfo) MarshalJSON added in v0.17.0 

func (s *MatchInfo) MarshalJSON() ([]byte, error)

type MergeInfo added in v0.64.0 

type MergeInfo struct {
	// NewAlertId: Optional. New alert ID. Reference the
	// [google.apps.alertcenter.Alert] with this ID for the current state.
	NewAlertId string `json:"newAlertId,omitempty"`

	// NewIncidentTrackingId: The new tracking ID from the parent incident.
	NewIncidentTrackingId string `json:"newIncidentTrackingId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "NewAlertId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NewAlertId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MergeInfo: New alert tracking numbers.

func (*MergeInfo) MarshalJSON added in v0.64.0 

func (s *MergeInfo) MarshalJSON() ([]byte, error)

type Notification 

type Notification struct {
	// CloudPubsubTopic: A Google Cloud Pub/sub topic destination.
	CloudPubsubTopic *CloudPubsubTopic `json:"cloudPubsubTopic,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CloudPubsubTopic") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CloudPubsubTopic") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Notification: Settings for callback notifications. For more details see Google Workspace Alert Notification (https://developers.google.com/admin-sdk/alertcenter/guides/notifications).

func (*Notification) MarshalJSON 

func (s *Notification) MarshalJSON() ([]byte, error)

type PhishingSpike 

type PhishingSpike struct {
	// DomainId: The domain ID.
	DomainId *DomainId `json:"domainId,omitempty"`

	// IsInternal: If `true`, the email originated from within the
	// organization.
	IsInternal bool `json:"isInternal,omitempty"`

	// MaliciousEntity: The entity whose actions triggered a Gmail phishing
	// alert.
	MaliciousEntity *MaliciousEntity `json:"maliciousEntity,omitempty"`

	// Messages: The list of messages contained by this alert.
	Messages []*GmailMessageInfo `json:"messages,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DomainId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DomainId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PhishingSpike: Alert for a spike in user reported phishing. *Warning*: This type has been deprecated. Use MailPhishing (/admin-sdk/alertcenter/reference/rest/v1beta1/MailPhishing) instead.

func (*PhishingSpike) MarshalJSON 

func (s *PhishingSpike) MarshalJSON() ([]byte, error)

type PredefinedDetectorInfo added in v0.17.0 

type PredefinedDetectorInfo struct {
	// DetectorName: Name that uniquely identifies the detector.
	DetectorName string `json:"detectorName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DetectorName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DetectorName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PredefinedDetectorInfo: Detector provided by Google.

func (*PredefinedDetectorInfo) MarshalJSON added in v0.17.0 

func (s *PredefinedDetectorInfo) MarshalJSON() ([]byte, error)

type PrimaryAdminChangedEvent added in v0.81.0 

type PrimaryAdminChangedEvent struct {
	// Domain: domain in which actioned occurred
	Domain string `json:"domain,omitempty"`

	// PreviousAdminEmail: Email of person who was the primary admin before
	// the action
	PreviousAdminEmail string `json:"previousAdminEmail,omitempty"`

	// UpdatedAdminEmail: Email of person who is the primary admin after the
	// action
	UpdatedAdminEmail string `json:"updatedAdminEmail,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Domain") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Domain") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PrimaryAdminChangedEvent: Event occurred when primary admin changed in customer's account. The event are being received from insight forwarder

func (*PrimaryAdminChangedEvent) MarshalJSON added in v0.81.0 

func (s *PrimaryAdminChangedEvent) MarshalJSON() ([]byte, error)

type ReportingRule added in v0.47.0 

type ReportingRule struct {
	// AlertDetails: Any other associated alert details, for example,
	// AlertConfiguration.
	AlertDetails string `json:"alertDetails,omitempty"`

	// Name: Rule name
	Name string `json:"name,omitempty"`

	// Query: Alert Rule query Sample Query query { condition { filter {
	// expected_application_id: 777491262838 expected_event_name:
	// "indexable_content_change" filter_op: IN } } conjunction_operator: OR
	// }
	Query string `json:"query,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AlertDetails") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AlertDetails") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReportingRule: Alerts from Reporting Rules configured by Admin.

func (*ReportingRule) MarshalJSON added in v0.47.0 

func (s *ReportingRule) MarshalJSON() ([]byte, error)

type RequestInfo added in v0.11.0 

type RequestInfo struct {
	// AppDeveloperEmail: List of app developers who triggered notifications
	// for above application.
	AppDeveloperEmail []string `json:"appDeveloperEmail,omitempty"`

	// AppKey: Required. The application that requires the SQL setup.
	AppKey string `json:"appKey,omitempty"`

	// NumberOfRequests: Required. Number of requests sent for this
	// application to set up default SQL instance.
	NumberOfRequests int64 `json:"numberOfRequests,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "AppDeveloperEmail")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AppDeveloperEmail") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RequestInfo: Requests for one application that needs default SQL setup.

func (*RequestInfo) MarshalJSON added in v0.11.0 

func (s *RequestInfo) MarshalJSON() ([]byte, error)

type ResourceInfo added in v0.17.0 

type ResourceInfo struct {
	// DocumentId: Drive file ID.
	DocumentId string `json:"documentId,omitempty"`

	// ResourceTitle: Title of the resource, for example email subject, or
	// document title.
	ResourceTitle string `json:"resourceTitle,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DocumentId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DocumentId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ResourceInfo: Proto that contains resource information.

func (*ResourceInfo) MarshalJSON added in v0.17.0 

func (s *ResourceInfo) MarshalJSON() ([]byte, error)

type RuleInfo added in v0.17.0 

type RuleInfo struct {
	// DisplayName: User provided name of the rule.
	DisplayName string `json:"displayName,omitempty"`

	// ResourceName: Resource name that uniquely identifies the rule.
	ResourceName string `json:"resourceName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RuleInfo: Proto that contains rule information.

func (*RuleInfo) MarshalJSON added in v0.17.0 

func (s *RuleInfo) MarshalJSON() ([]byte, error)

type RuleViolationInfo added in v0.17.0 

type RuleViolationInfo struct {
	// DataSource: Source of the data.
	//
	// Possible values:
	//   "DATA_SOURCE_UNSPECIFIED" - Data source is unspecified.
	//   "DRIVE" - Drive data source.
	DataSource string `json:"dataSource,omitempty"`

	// MatchInfo: List of matches that were found in the resource content.
	MatchInfo []*MatchInfo `json:"matchInfo,omitempty"`

	// Recipients: Resource recipients. For Drive, they are grantees that
	// the Drive file was shared with at the time of rule triggering. Valid
	// values include user emails, group emails, domains, or 'anyone' if the
	// file was publicly accessible. If the file was private the recipients
	// list will be empty. For Gmail, they are emails of the users or groups
	// that the Gmail message was sent to.
	Recipients []string `json:"recipients,omitempty"`

	// ResourceInfo: Details of the resource which violated the rule.
	ResourceInfo *ResourceInfo `json:"resourceInfo,omitempty"`

	// RuleInfo: Details of the violated rule.
	RuleInfo *RuleInfo `json:"ruleInfo,omitempty"`

	// SuppressedActionTypes: Actions suppressed due to other actions with
	// higher priority.
	//
	// Possible values:
	//   "ACTION_TYPE_UNSPECIFIED" - Action type is unspecified.
	//   "DRIVE_BLOCK_EXTERNAL_SHARING" - Block sharing a file externally.
	//   "DRIVE_WARN_ON_EXTERNAL_SHARING" - Show a warning message when
	// sharing a file externally.
	//   "ALERT" - Send alert.
	//   "RULE_ACTIVATE" - Activate Rule Action
	//   "RULE_DEACTIVATE" - Deactivate Rule Action
	SuppressedActionTypes []string `json:"suppressedActionTypes,omitempty"`

	// Trigger: Trigger of the rule.
	//
	// Possible values:
	//   "TRIGGER_UNSPECIFIED" - Trigger is unspecified.
	//   "DRIVE_SHARE" - A Drive file is shared.
	Trigger string `json:"trigger,omitempty"`

	// TriggeredActionInfo: Metadata related to the triggered actions.
	TriggeredActionInfo []*ActionInfo `json:"triggeredActionInfo,omitempty"`

	// TriggeredActionTypes: Actions applied as a consequence of the rule
	// being triggered.
	//
	// Possible values:
	//   "ACTION_TYPE_UNSPECIFIED" - Action type is unspecified.
	//   "DRIVE_BLOCK_EXTERNAL_SHARING" - Block sharing a file externally.
	//   "DRIVE_WARN_ON_EXTERNAL_SHARING" - Show a warning message when
	// sharing a file externally.
	//   "ALERT" - Send alert.
	//   "RULE_ACTIVATE" - Activate Rule Action
	//   "RULE_DEACTIVATE" - Deactivate Rule Action
	TriggeredActionTypes []string `json:"triggeredActionTypes,omitempty"`

	// TriggeringUserEmail: Email of the user who caused the violation.
	// Value could be empty if not applicable, for example, a violation
	// found by drive continuous scan.
	TriggeringUserEmail string `json:"triggeringUserEmail,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataSource") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataSource") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RuleViolationInfo: Common alert information about violated rules that are configured by Google Workspace administrators.

func (*RuleViolationInfo) MarshalJSON added in v0.17.0 

func (s *RuleViolationInfo) MarshalJSON() ([]byte, error)

type SSOProfileCreatedEvent added in v0.81.0 

type SSOProfileCreatedEvent struct {
	// InboundSsoProfileName: sso profile name which got created
	InboundSsoProfileName string `json:"inboundSsoProfileName,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "InboundSsoProfileName") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InboundSsoProfileName") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SSOProfileCreatedEvent: Event occurred when SSO Profile created in customer's account. The event are being received from insight forwarder

func (*SSOProfileCreatedEvent) MarshalJSON added in v0.81.0 

func (s *SSOProfileCreatedEvent) MarshalJSON() ([]byte, error)

type SSOProfileDeletedEvent added in v0.81.0 

type SSOProfileDeletedEvent struct {
	// InboundSsoProfileName: sso profile name which got deleted
	InboundSsoProfileName string `json:"inboundSsoProfileName,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "InboundSsoProfileName") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InboundSsoProfileName") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SSOProfileDeletedEvent: Event occurred when SSO Profile deleted in customer's account. The event are being received from insight forwarder

func (*SSOProfileDeletedEvent) MarshalJSON added in v0.81.0 

func (s *SSOProfileDeletedEvent) MarshalJSON() ([]byte, error)

type SSOProfileUpdatedEvent added in v0.81.0 

type SSOProfileUpdatedEvent struct {
	// InboundSsoProfileChanges: changes made to sso profile
	InboundSsoProfileChanges string `json:"inboundSsoProfileChanges,omitempty"`

	// InboundSsoProfileName: sso profile name which got updated
	InboundSsoProfileName string `json:"inboundSsoProfileName,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "InboundSsoProfileChanges") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InboundSsoProfileChanges")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SSOProfileUpdatedEvent: Event occurred when SSO Profile updated in customer's account. The event are being received from insight forwarder

func (*SSOProfileUpdatedEvent) MarshalJSON added in v0.81.0 

func (s *SSOProfileUpdatedEvent) MarshalJSON() ([]byte, error)

type SensitiveAdminAction added in v0.81.0 

type SensitiveAdminAction struct {
	// ActorEmail: Email of person who performed the action
	ActorEmail string `json:"actorEmail,omitempty"`

	// EventTime: The time at which event occurred
	EventTime string `json:"eventTime,omitempty"`

	// PrimaryAdminChangedEvent: Event occurred when primary admin changed
	// in customer's account
	PrimaryAdminChangedEvent *PrimaryAdminChangedEvent `json:"primaryAdminChangedEvent,omitempty"`

	// SsoProfileCreatedEvent: Event occurred when SSO Profile created in
	// customer's account
	SsoProfileCreatedEvent *SSOProfileCreatedEvent `json:"ssoProfileCreatedEvent,omitempty"`

	// SsoProfileDeletedEvent: Event occurred when SSO Profile deleted in
	// customer's account
	SsoProfileDeletedEvent *SSOProfileDeletedEvent `json:"ssoProfileDeletedEvent,omitempty"`

	// SsoProfileUpdatedEvent: Event occurred when SSO Profile updated in
	// customer's account
	SsoProfileUpdatedEvent *SSOProfileUpdatedEvent `json:"ssoProfileUpdatedEvent,omitempty"`

	// SuperAdminPasswordResetEvent: Event occurred when password was reset
	// for super admin in customer's account
	SuperAdminPasswordResetEvent *SuperAdminPasswordResetEvent `json:"superAdminPasswordResetEvent,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ActorEmail") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ActorEmail") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SensitiveAdminAction: Alert that is triggered when Sensitive Admin Action occur in customer account.

func (*SensitiveAdminAction) MarshalJSON added in v0.81.0 

func (s *SensitiveAdminAction) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Alerts *AlertsService

	V1beta1 *V1beta1Service
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Settings 

type Settings struct {
	// Notifications: The list of notifications.
	Notifications []*Notification `json:"notifications,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Notifications") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Notifications") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Settings: Customer-level settings.

func (*Settings) MarshalJSON 

func (s *Settings) MarshalJSON() ([]byte, error)

type StateSponsoredAttack 

type StateSponsoredAttack struct {
	// Email: The email of the user this incident was created for.
	Email string `json:"email,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StateSponsoredAttack: A state-sponsored attack alert. Derived from audit logs.

func (*StateSponsoredAttack) MarshalJSON 

func (s *StateSponsoredAttack) MarshalJSON() ([]byte, error)

type Status added in v0.10.0 

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON added in v0.10.0 

func (s *Status) MarshalJSON() ([]byte, error)

type SuperAdminPasswordResetEvent added in v0.81.0 

type SuperAdminPasswordResetEvent struct {
	// UserEmail: email of person whose password was reset
	UserEmail string `json:"userEmail,omitempty"`

	// ForceSendFields is a list of field names (e.g. "UserEmail") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "UserEmail") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SuperAdminPasswordResetEvent: Event occurred when password was reset for super admin in customer's account. The event are being received from insight forwarder

func (*SuperAdminPasswordResetEvent) MarshalJSON added in v0.81.0 

func (s *SuperAdminPasswordResetEvent) MarshalJSON() ([]byte, error)

type SuspiciousActivity 

type SuspiciousActivity struct {
	// Email: The email of the user this alert was created for.
	Email string `json:"email,omitempty"`

	// Events: Required. The list of security events.
	Events []*SuspiciousActivitySecurityDetail `json:"events,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SuspiciousActivity: A mobile suspicious activity alert. Derived from audit logs.

func (*SuspiciousActivity) MarshalJSON 

func (s *SuspiciousActivity) MarshalJSON() ([]byte, error)

type SuspiciousActivitySecurityDetail 

type SuspiciousActivitySecurityDetail struct {
	// DeviceId: Required. The device ID.
	DeviceId string `json:"deviceId,omitempty"`

	// DeviceModel: The model of the device.
	DeviceModel string `json:"deviceModel,omitempty"`

	// DeviceProperty: The device property which was changed.
	DeviceProperty string `json:"deviceProperty,omitempty"`

	// DeviceType: The type of the device.
	DeviceType string `json:"deviceType,omitempty"`

	// IosVendorId: Required for iOS, empty for others.
	IosVendorId string `json:"iosVendorId,omitempty"`

	// NewValue: The new value of the device property after the change.
	NewValue string `json:"newValue,omitempty"`

	// OldValue: The old value of the device property before the change.
	OldValue string `json:"oldValue,omitempty"`

	// ResourceId: The device resource ID.
	ResourceId string `json:"resourceId,omitempty"`

	// SerialNumber: The serial number of the device.
	SerialNumber string `json:"serialNumber,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeviceId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeviceId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SuspiciousActivitySecurityDetail: Detailed information of a single MDM suspicious activity event.

func (*SuspiciousActivitySecurityDetail) MarshalJSON 

func (s *SuspiciousActivitySecurityDetail) MarshalJSON() ([]byte, error)

type UndeleteAlertRequest 

type UndeleteAlertRequest struct {
	// CustomerId: Optional. The unique identifier of the Google Workspace
	// organization account of the customer the alert is associated with.
	// Inferred from the caller identity if not provided.
	CustomerId string `json:"customerId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CustomerId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CustomerId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UndeleteAlertRequest: A request to undelete a specific alert that was marked for deletion.

func (*UndeleteAlertRequest) MarshalJSON 

func (s *UndeleteAlertRequest) MarshalJSON() ([]byte, error)

type User added in v0.16.0 

type User struct {
	// DisplayName: Display name of the user.
	DisplayName string `json:"displayName,omitempty"`

	// EmailAddress: Email address of the user.
	EmailAddress string `json:"emailAddress,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

User: A user.

func (*User) MarshalJSON added in v0.16.0 

func (s *User) MarshalJSON() ([]byte, error)

type UserChanges added in v0.47.0 

type UserChanges struct {
	// Name: Rule name
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UserChanges: Alerts from UserChanges bucket Rules for predefined rules which contain the below rules. Suspended user made active New user Added User suspended (by admin) User granted admin privileges User admin privileges revoked User deleted Users password changed

func (*UserChanges) MarshalJSON added in v0.47.0 

func (s *UserChanges) MarshalJSON() ([]byte, error)

type UserDefinedDetectorInfo added in v0.17.0 

type UserDefinedDetectorInfo struct {
	// DisplayName: Display name of the detector.
	DisplayName string `json:"displayName,omitempty"`

	// ResourceName: Resource name that uniquely identifies the detector.
	ResourceName string `json:"resourceName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UserDefinedDetectorInfo: Detector defined by administrators.

func (*UserDefinedDetectorInfo) MarshalJSON added in v0.17.0 

func (s *UserDefinedDetectorInfo) MarshalJSON() ([]byte, error)

type V1beta1GetSettingsCall 

type V1beta1GetSettingsCall struct {
	// contains filtered or unexported fields
}

func (*V1beta1GetSettingsCall) Context 

func (c *V1beta1GetSettingsCall) Context(ctx context.Context) *V1beta1GetSettingsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1beta1GetSettingsCall) CustomerId 

func (c *V1beta1GetSettingsCall) CustomerId(customerId string) *V1beta1GetSettingsCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.

func (*V1beta1GetSettingsCall) Do 

func (c *V1beta1GetSettingsCall) Do(opts ...googleapi.CallOption) (*Settings, error)

Do executes the "alertcenter.getSettings" call. Exactly one of *Settings or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Settings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1beta1GetSettingsCall) Fields 

func (c *V1beta1GetSettingsCall) Fields(s ...googleapi.Field) *V1beta1GetSettingsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1beta1GetSettingsCall) Header 

func (c *V1beta1GetSettingsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*V1beta1GetSettingsCall) IfNoneMatch 

func (c *V1beta1GetSettingsCall) IfNoneMatch(entityTag string) *V1beta1GetSettingsCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type V1beta1Service 

type V1beta1Service struct {
	// contains filtered or unexported fields
}

func NewV1beta1Service 

func NewV1beta1Service(s *Service) *V1beta1Service

func (*V1beta1Service) GetSettings 

func (r *V1beta1Service) GetSettings() *V1beta1GetSettingsCall

GetSettings: Returns customer-level settings.

func (*V1beta1Service) UpdateSettings 

func (r *V1beta1Service) UpdateSettings(settings *Settings) *V1beta1UpdateSettingsCall

UpdateSettings: Updates the customer-level settings.

type V1beta1UpdateSettingsCall 

type V1beta1UpdateSettingsCall struct {
	// contains filtered or unexported fields
}

func (*V1beta1UpdateSettingsCall) Context 

func (c *V1beta1UpdateSettingsCall) Context(ctx context.Context) *V1beta1UpdateSettingsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1beta1UpdateSettingsCall) CustomerId 

func (c *V1beta1UpdateSettingsCall) CustomerId(customerId string) *V1beta1UpdateSettingsCall

CustomerId sets the optional parameter "customerId": The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.

func (*V1beta1UpdateSettingsCall) Do 

func (c *V1beta1UpdateSettingsCall) Do(opts ...googleapi.CallOption) (*Settings, error)

Do executes the "alertcenter.updateSettings" call. Exactly one of *Settings or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Settings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1beta1UpdateSettingsCall) Fields 

func (c *V1beta1UpdateSettingsCall) Fields(s ...googleapi.Field) *V1beta1UpdateSettingsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1beta1UpdateSettingsCall) Header 

func (c *V1beta1UpdateSettingsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.