alertcenter

package
v0.0.0-...-6cb3ea0 Latest Latest
Warning

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

Go to latest
Published: Jun 7, 2021 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	AlertFeedbackType_name = map[int32]string{
		0: "ALERT_FEEDBACK_TYPE_UNSPECIFIED",
		1: "NOT_USEFUL",
		2: "SOMEWHAT_USEFUL",
		3: "VERY_USEFUL",
	}
	AlertFeedbackType_value = map[string]int32{
		"ALERT_FEEDBACK_TYPE_UNSPECIFIED": 0,
		"NOT_USEFUL":                      1,
		"SOMEWHAT_USEFUL":                 2,
		"VERY_USEFUL":                     3,
	}
)

Enum value maps for AlertFeedbackType.

View Source
var (
	Settings_Notification_PayloadFormat_name = map[int32]string{
		0: "PAYLOAD_FORMAT_UNSPECIFIED",
		1: "JSON",
	}
	Settings_Notification_PayloadFormat_value = map[string]int32{
		"PAYLOAD_FORMAT_UNSPECIFIED": 0,
		"JSON":                       1,
	}
)

Enum value maps for Settings_Notification_PayloadFormat.

View Source
var File_google_apps_alertcenter_v1beta1_alertcenter_proto protoreflect.FileDescriptor

Functions

func RegisterAlertCenterServiceServer

func RegisterAlertCenterServiceServer(s *grpc.Server, srv AlertCenterServiceServer)

Types

type Alert

type Alert struct {

	// Output only. The unique identifier of the Google account of the customer.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Output only. The unique identifier for the alert.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// Output only. The time this alert was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Required. The time the event that caused this alert was started or
	// detected.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// 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 *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// 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 `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"`
	// 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
	// * Domain wide takeout
	// * State sponsored attack
	// * Google identity
	Source string `protobuf:"bytes,7,opt,name=source,proto3" json:"source,omitempty"`
	// Optional. The data associated with this alert, for example
	// [google.apps.alertcenter.type.DeviceCompromised] [google.apps.alertcenter.type.DeviceCompromised].
	Data *anypb.Any `protobuf:"bytes,8,opt,name=data,proto3" json:"data,omitempty"`
	// Output only. An optional
	// [Security Investigation Tool](https://support.google.com/a/answer/7575955)
	// query for this alert.
	SecurityInvestigationToolLink string `` /* 152-byte string literal not displayed */
	// Output only. `True` if this alert is marked for deletion.
	Deleted bool `protobuf:"varint,11,opt,name=deleted,proto3" json:"deleted,omitempty"`
	// Output only. The metadata associated with this alert.
	Metadata *AlertMetadata `protobuf:"bytes,12,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Output only. The time this alert was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// 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 `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

An alert affecting a customer.

func (*Alert) Descriptor deprecated

func (*Alert) Descriptor() ([]byte, []int)

Deprecated: Use Alert.ProtoReflect.Descriptor instead.

func (*Alert) GetAlertId

func (x *Alert) GetAlertId() string

func (*Alert) GetCreateTime

func (x *Alert) GetCreateTime() *timestamppb.Timestamp

func (*Alert) GetCustomerId

func (x *Alert) GetCustomerId() string

func (*Alert) GetData

func (x *Alert) GetData() *anypb.Any

func (*Alert) GetDeleted

func (x *Alert) GetDeleted() bool

func (*Alert) GetEndTime

func (x *Alert) GetEndTime() *timestamppb.Timestamp

func (*Alert) GetEtag

func (x *Alert) GetEtag() string

func (*Alert) GetMetadata

func (x *Alert) GetMetadata() *AlertMetadata
func (x *Alert) GetSecurityInvestigationToolLink() string

func (*Alert) GetSource

func (x *Alert) GetSource() string

func (*Alert) GetStartTime

func (x *Alert) GetStartTime() *timestamppb.Timestamp

func (*Alert) GetType

func (x *Alert) GetType() string

func (*Alert) GetUpdateTime

func (x *Alert) GetUpdateTime() *timestamppb.Timestamp

func (*Alert) ProtoMessage

func (*Alert) ProtoMessage()

func (*Alert) ProtoReflect

func (x *Alert) ProtoReflect() protoreflect.Message

func (*Alert) Reset

func (x *Alert) Reset()

func (*Alert) String

func (x *Alert) String() string

type AlertCenterServiceClient

type AlertCenterServiceClient interface {
	// Lists the alerts.
	ListAlerts(ctx context.Context, in *ListAlertsRequest, opts ...grpc.CallOption) (*ListAlertsResponse, error)
	// Gets the specified alert. Attempting to get a nonexistent alert returns
	// `NOT_FOUND` error.
	GetAlert(ctx context.Context, in *GetAlertRequest, opts ...grpc.CallOption) (*Alert, error)
	// 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.
	DeleteAlert(ctx context.Context, in *DeleteAlertRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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.
	UndeleteAlert(ctx context.Context, in *UndeleteAlertRequest, opts ...grpc.CallOption) (*Alert, error)
	// 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.
	CreateAlertFeedback(ctx context.Context, in *CreateAlertFeedbackRequest, opts ...grpc.CallOption) (*AlertFeedback, error)
	// Lists all the feedback for an alert. Attempting to list feedbacks for
	// a non-existent alert returns `NOT_FOUND` error.
	ListAlertFeedback(ctx context.Context, in *ListAlertFeedbackRequest, opts ...grpc.CallOption) (*ListAlertFeedbackResponse, error)
	// Returns the metadata of an alert. Attempting to get metadata for
	// a non-existent alert returns `NOT_FOUND` error.
	GetAlertMetadata(ctx context.Context, in *GetAlertMetadataRequest, opts ...grpc.CallOption) (*AlertMetadata, error)
	// Returns customer-level settings.
	GetSettings(ctx context.Context, in *GetSettingsRequest, opts ...grpc.CallOption) (*Settings, error)
	// Updates the customer-level settings.
	UpdateSettings(ctx context.Context, in *UpdateSettingsRequest, opts ...grpc.CallOption) (*Settings, error)
	// Performs batch delete operation on alerts.
	BatchDeleteAlerts(ctx context.Context, in *BatchDeleteAlertsRequest, opts ...grpc.CallOption) (*BatchDeleteAlertsResponse, error)
	// Performs batch undelete operation on alerts.
	BatchUndeleteAlerts(ctx context.Context, in *BatchUndeleteAlertsRequest, opts ...grpc.CallOption) (*BatchUndeleteAlertsResponse, error)
}

AlertCenterServiceClient is the client API for AlertCenterService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type AlertCenterServiceServer

type AlertCenterServiceServer interface {
	// Lists the alerts.
	ListAlerts(context.Context, *ListAlertsRequest) (*ListAlertsResponse, error)
	// Gets the specified alert. Attempting to get a nonexistent alert returns
	// `NOT_FOUND` error.
	GetAlert(context.Context, *GetAlertRequest) (*Alert, error)
	// 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.
	DeleteAlert(context.Context, *DeleteAlertRequest) (*emptypb.Empty, error)
	// 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.
	UndeleteAlert(context.Context, *UndeleteAlertRequest) (*Alert, error)
	// 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.
	CreateAlertFeedback(context.Context, *CreateAlertFeedbackRequest) (*AlertFeedback, error)
	// Lists all the feedback for an alert. Attempting to list feedbacks for
	// a non-existent alert returns `NOT_FOUND` error.
	ListAlertFeedback(context.Context, *ListAlertFeedbackRequest) (*ListAlertFeedbackResponse, error)
	// Returns the metadata of an alert. Attempting to get metadata for
	// a non-existent alert returns `NOT_FOUND` error.
	GetAlertMetadata(context.Context, *GetAlertMetadataRequest) (*AlertMetadata, error)
	// Returns customer-level settings.
	GetSettings(context.Context, *GetSettingsRequest) (*Settings, error)
	// Updates the customer-level settings.
	UpdateSettings(context.Context, *UpdateSettingsRequest) (*Settings, error)
	// Performs batch delete operation on alerts.
	BatchDeleteAlerts(context.Context, *BatchDeleteAlertsRequest) (*BatchDeleteAlertsResponse, error)
	// Performs batch undelete operation on alerts.
	BatchUndeleteAlerts(context.Context, *BatchUndeleteAlertsRequest) (*BatchUndeleteAlertsResponse, error)
}

AlertCenterServiceServer is the server API for AlertCenterService service.

type AlertFeedback

type AlertFeedback struct {

	// Output only. The unique identifier of the Google account of the customer.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Output only. The alert identifier.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// Output only. The unique identifier for the feedback.
	FeedbackId string `protobuf:"bytes,3,opt,name=feedback_id,json=feedbackId,proto3" json:"feedback_id,omitempty"`
	// Output only. The time this feedback was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Required. The type of the feedback.
	Type AlertFeedbackType `protobuf:"varint,5,opt,name=type,proto3,enum=google.apps.alertcenter.v1beta1.AlertFeedbackType" json:"type,omitempty"`
	// Output only. The email of the user that provided the feedback.
	Email string `protobuf:"bytes,6,opt,name=email,proto3" json:"email,omitempty"`
	// contains filtered or unexported fields
}

A customer feedback about an alert.

func (*AlertFeedback) Descriptor deprecated

func (*AlertFeedback) Descriptor() ([]byte, []int)

Deprecated: Use AlertFeedback.ProtoReflect.Descriptor instead.

func (*AlertFeedback) GetAlertId

func (x *AlertFeedback) GetAlertId() string

func (*AlertFeedback) GetCreateTime

func (x *AlertFeedback) GetCreateTime() *timestamppb.Timestamp

func (*AlertFeedback) GetCustomerId

func (x *AlertFeedback) GetCustomerId() string

func (*AlertFeedback) GetEmail

func (x *AlertFeedback) GetEmail() string

func (*AlertFeedback) GetFeedbackId

func (x *AlertFeedback) GetFeedbackId() string

func (*AlertFeedback) GetType

func (x *AlertFeedback) GetType() AlertFeedbackType

func (*AlertFeedback) ProtoMessage

func (*AlertFeedback) ProtoMessage()

func (*AlertFeedback) ProtoReflect

func (x *AlertFeedback) ProtoReflect() protoreflect.Message

func (*AlertFeedback) Reset

func (x *AlertFeedback) Reset()

func (*AlertFeedback) String

func (x *AlertFeedback) String() string

type AlertFeedbackType

type AlertFeedbackType int32

The type of alert feedback.

const (
	// The feedback type is not specified.
	AlertFeedbackType_ALERT_FEEDBACK_TYPE_UNSPECIFIED AlertFeedbackType = 0
	// The alert report is not useful.
	AlertFeedbackType_NOT_USEFUL AlertFeedbackType = 1
	// The alert report is somewhat useful.
	AlertFeedbackType_SOMEWHAT_USEFUL AlertFeedbackType = 2
	// The alert report is very useful.
	AlertFeedbackType_VERY_USEFUL AlertFeedbackType = 3
)

func (AlertFeedbackType) Descriptor

func (AlertFeedbackType) Enum

func (AlertFeedbackType) EnumDescriptor deprecated

func (AlertFeedbackType) EnumDescriptor() ([]byte, []int)

Deprecated: Use AlertFeedbackType.Descriptor instead.

func (AlertFeedbackType) Number

func (AlertFeedbackType) String

func (x AlertFeedbackType) String() string

func (AlertFeedbackType) Type

type AlertMetadata

type AlertMetadata struct {

	// Output only. The unique identifier of the Google account of the customer.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Output only. The alert identifier.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// The current status of the alert.
	// The supported values are the following:
	//
	// * NOT_STARTED
	// * IN_PROGRESS
	// * CLOSED
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// The email address of the user assigned to the alert.
	Assignee string `protobuf:"bytes,5,opt,name=assignee,proto3" json:"assignee,omitempty"`
	// Output only. The time this metadata was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// 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 `protobuf:"bytes,7,opt,name=severity,proto3" json:"severity,omitempty"`
	// 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 metatdata 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 `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

An alert metadata.

func (*AlertMetadata) Descriptor deprecated

func (*AlertMetadata) Descriptor() ([]byte, []int)

Deprecated: Use AlertMetadata.ProtoReflect.Descriptor instead.

func (*AlertMetadata) GetAlertId

func (x *AlertMetadata) GetAlertId() string

func (*AlertMetadata) GetAssignee

func (x *AlertMetadata) GetAssignee() string

func (*AlertMetadata) GetCustomerId

func (x *AlertMetadata) GetCustomerId() string

func (*AlertMetadata) GetEtag

func (x *AlertMetadata) GetEtag() string

func (*AlertMetadata) GetSeverity

func (x *AlertMetadata) GetSeverity() string

func (*AlertMetadata) GetStatus

func (x *AlertMetadata) GetStatus() string

func (*AlertMetadata) GetUpdateTime

func (x *AlertMetadata) GetUpdateTime() *timestamppb.Timestamp

func (*AlertMetadata) ProtoMessage

func (*AlertMetadata) ProtoMessage()

func (*AlertMetadata) ProtoReflect

func (x *AlertMetadata) ProtoReflect() protoreflect.Message

func (*AlertMetadata) Reset

func (x *AlertMetadata) Reset()

func (*AlertMetadata) String

func (x *AlertMetadata) String() string

type BatchDeleteAlertsRequest

type BatchDeleteAlertsRequest struct {

	// Optional. The unique identifier of the Google Workspace organization
	// account of the customer the alerts are associated with.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. list of alert IDs.
	AlertId []string `protobuf:"bytes,2,rep,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// contains filtered or unexported fields
}

A request to perform batch delete on alerts.

func (*BatchDeleteAlertsRequest) Descriptor deprecated

func (*BatchDeleteAlertsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteAlertsRequest.ProtoReflect.Descriptor instead.

func (*BatchDeleteAlertsRequest) GetAlertId

func (x *BatchDeleteAlertsRequest) GetAlertId() []string

func (*BatchDeleteAlertsRequest) GetCustomerId

func (x *BatchDeleteAlertsRequest) GetCustomerId() string

func (*BatchDeleteAlertsRequest) ProtoMessage

func (*BatchDeleteAlertsRequest) ProtoMessage()

func (*BatchDeleteAlertsRequest) ProtoReflect

func (x *BatchDeleteAlertsRequest) ProtoReflect() protoreflect.Message

func (*BatchDeleteAlertsRequest) Reset

func (x *BatchDeleteAlertsRequest) Reset()

func (*BatchDeleteAlertsRequest) String

func (x *BatchDeleteAlertsRequest) String() string

type BatchDeleteAlertsResponse

type BatchDeleteAlertsResponse struct {

	// The successful list of alert IDs.
	SuccessAlertIds []string `protobuf:"bytes,1,rep,name=success_alert_ids,json=successAlertIds,proto3" json:"success_alert_ids,omitempty"`
	// The status details for each failed alert_id.
	FailedAlertStatus map[string]*status.Status `` /* 202-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to batch delete operation on alerts.

func (*BatchDeleteAlertsResponse) Descriptor deprecated

func (*BatchDeleteAlertsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteAlertsResponse.ProtoReflect.Descriptor instead.

func (*BatchDeleteAlertsResponse) GetFailedAlertStatus

func (x *BatchDeleteAlertsResponse) GetFailedAlertStatus() map[string]*status.Status

func (*BatchDeleteAlertsResponse) GetSuccessAlertIds

func (x *BatchDeleteAlertsResponse) GetSuccessAlertIds() []string

func (*BatchDeleteAlertsResponse) ProtoMessage

func (*BatchDeleteAlertsResponse) ProtoMessage()

func (*BatchDeleteAlertsResponse) ProtoReflect

func (*BatchDeleteAlertsResponse) Reset

func (x *BatchDeleteAlertsResponse) Reset()

func (*BatchDeleteAlertsResponse) String

func (x *BatchDeleteAlertsResponse) String() string

type BatchUndeleteAlertsRequest

type BatchUndeleteAlertsRequest struct {

	// Optional. The unique identifier of the Google Workspace organization
	// account of the customer the alerts are associated with.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. list of alert IDs.
	AlertId []string `protobuf:"bytes,2,rep,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// contains filtered or unexported fields
}

A request to perform batch undelete on alerts.

func (*BatchUndeleteAlertsRequest) Descriptor deprecated

func (*BatchUndeleteAlertsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchUndeleteAlertsRequest.ProtoReflect.Descriptor instead.

func (*BatchUndeleteAlertsRequest) GetAlertId

func (x *BatchUndeleteAlertsRequest) GetAlertId() []string

func (*BatchUndeleteAlertsRequest) GetCustomerId

func (x *BatchUndeleteAlertsRequest) GetCustomerId() string

func (*BatchUndeleteAlertsRequest) ProtoMessage

func (*BatchUndeleteAlertsRequest) ProtoMessage()

func (*BatchUndeleteAlertsRequest) ProtoReflect

func (*BatchUndeleteAlertsRequest) Reset

func (x *BatchUndeleteAlertsRequest) Reset()

func (*BatchUndeleteAlertsRequest) String

func (x *BatchUndeleteAlertsRequest) String() string

type BatchUndeleteAlertsResponse

type BatchUndeleteAlertsResponse struct {

	// The successful list of alert IDs.
	SuccessAlertIds []string `protobuf:"bytes,1,rep,name=success_alert_ids,json=successAlertIds,proto3" json:"success_alert_ids,omitempty"`
	// The status details for each failed alert_id.
	FailedAlertStatus map[string]*status.Status `` /* 202-byte string literal not displayed */
	// contains filtered or unexported fields
}

Response to batch undelete operation on alerts.

func (*BatchUndeleteAlertsResponse) Descriptor deprecated

func (*BatchUndeleteAlertsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchUndeleteAlertsResponse.ProtoReflect.Descriptor instead.

func (*BatchUndeleteAlertsResponse) GetFailedAlertStatus

func (x *BatchUndeleteAlertsResponse) GetFailedAlertStatus() map[string]*status.Status

func (*BatchUndeleteAlertsResponse) GetSuccessAlertIds

func (x *BatchUndeleteAlertsResponse) GetSuccessAlertIds() []string

func (*BatchUndeleteAlertsResponse) ProtoMessage

func (*BatchUndeleteAlertsResponse) ProtoMessage()

func (*BatchUndeleteAlertsResponse) ProtoReflect

func (*BatchUndeleteAlertsResponse) Reset

func (x *BatchUndeleteAlertsResponse) Reset()

func (*BatchUndeleteAlertsResponse) String

func (x *BatchUndeleteAlertsResponse) String() string

type CreateAlertFeedbackRequest

type CreateAlertFeedbackRequest struct {

	// 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 `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. The identifier of the alert this feedback belongs to.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// Required. The new alert feedback to create.
	Feedback *AlertFeedback `protobuf:"bytes,3,opt,name=feedback,proto3" json:"feedback,omitempty"`
	// contains filtered or unexported fields
}

A request to create a new alert feedback.

func (*CreateAlertFeedbackRequest) Descriptor deprecated

func (*CreateAlertFeedbackRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateAlertFeedbackRequest.ProtoReflect.Descriptor instead.

func (*CreateAlertFeedbackRequest) GetAlertId

func (x *CreateAlertFeedbackRequest) GetAlertId() string

func (*CreateAlertFeedbackRequest) GetCustomerId

func (x *CreateAlertFeedbackRequest) GetCustomerId() string

func (*CreateAlertFeedbackRequest) GetFeedback

func (x *CreateAlertFeedbackRequest) GetFeedback() *AlertFeedback

func (*CreateAlertFeedbackRequest) ProtoMessage

func (*CreateAlertFeedbackRequest) ProtoMessage()

func (*CreateAlertFeedbackRequest) ProtoReflect

func (*CreateAlertFeedbackRequest) Reset

func (x *CreateAlertFeedbackRequest) Reset()

func (*CreateAlertFeedbackRequest) String

func (x *CreateAlertFeedbackRequest) String() string

type DeleteAlertRequest

type DeleteAlertRequest struct {

	// 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 `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. The identifier of the alert to delete.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// contains filtered or unexported fields
}

A request to mark a specific alert for deletion.

func (*DeleteAlertRequest) Descriptor deprecated

func (*DeleteAlertRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteAlertRequest.ProtoReflect.Descriptor instead.

func (*DeleteAlertRequest) GetAlertId

func (x *DeleteAlertRequest) GetAlertId() string

func (*DeleteAlertRequest) GetCustomerId

func (x *DeleteAlertRequest) GetCustomerId() string

func (*DeleteAlertRequest) ProtoMessage

func (*DeleteAlertRequest) ProtoMessage()

func (*DeleteAlertRequest) ProtoReflect

func (x *DeleteAlertRequest) ProtoReflect() protoreflect.Message

func (*DeleteAlertRequest) Reset

func (x *DeleteAlertRequest) Reset()

func (*DeleteAlertRequest) String

func (x *DeleteAlertRequest) String() string

type GetAlertMetadataRequest

type GetAlertMetadataRequest struct {

	// Optional. 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.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. The identifier of the alert this metadata belongs to.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// contains filtered or unexported fields
}

Get the alert metadata.

func (*GetAlertMetadataRequest) Descriptor deprecated

func (*GetAlertMetadataRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAlertMetadataRequest.ProtoReflect.Descriptor instead.

func (*GetAlertMetadataRequest) GetAlertId

func (x *GetAlertMetadataRequest) GetAlertId() string

func (*GetAlertMetadataRequest) GetCustomerId

func (x *GetAlertMetadataRequest) GetCustomerId() string

func (*GetAlertMetadataRequest) ProtoMessage

func (*GetAlertMetadataRequest) ProtoMessage()

func (*GetAlertMetadataRequest) ProtoReflect

func (x *GetAlertMetadataRequest) ProtoReflect() protoreflect.Message

func (*GetAlertMetadataRequest) Reset

func (x *GetAlertMetadataRequest) Reset()

func (*GetAlertMetadataRequest) String

func (x *GetAlertMetadataRequest) String() string

type GetAlertRequest

type GetAlertRequest struct {

	// 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 `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. The identifier of the alert to retrieve.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// contains filtered or unexported fields
}

Request for a specific alert.

func (*GetAlertRequest) Descriptor deprecated

func (*GetAlertRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAlertRequest.ProtoReflect.Descriptor instead.

func (*GetAlertRequest) GetAlertId

func (x *GetAlertRequest) GetAlertId() string

func (*GetAlertRequest) GetCustomerId

func (x *GetAlertRequest) GetCustomerId() string

func (*GetAlertRequest) ProtoMessage

func (*GetAlertRequest) ProtoMessage()

func (*GetAlertRequest) ProtoReflect

func (x *GetAlertRequest) ProtoReflect() protoreflect.Message

func (*GetAlertRequest) Reset

func (x *GetAlertRequest) Reset()

func (*GetAlertRequest) String

func (x *GetAlertRequest) String() string

type GetSettingsRequest

type GetSettingsRequest struct {

	// Optional. 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.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// contains filtered or unexported fields
}

Get the customer level settings.

func (*GetSettingsRequest) Descriptor deprecated

func (*GetSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSettingsRequest.ProtoReflect.Descriptor instead.

func (*GetSettingsRequest) GetCustomerId

func (x *GetSettingsRequest) GetCustomerId() string

func (*GetSettingsRequest) ProtoMessage

func (*GetSettingsRequest) ProtoMessage()

func (*GetSettingsRequest) ProtoReflect

func (x *GetSettingsRequest) ProtoReflect() protoreflect.Message

func (*GetSettingsRequest) Reset

func (x *GetSettingsRequest) Reset()

func (*GetSettingsRequest) String

func (x *GetSettingsRequest) String() string

type ListAlertFeedbackRequest

type ListAlertFeedbackRequest struct {

	// Optional. 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.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. The alert identifier.
	// The "-" wildcard could be used to represent all alerts.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// Optional. 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).
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

An alert feedback listing request.

func (*ListAlertFeedbackRequest) Descriptor deprecated

func (*ListAlertFeedbackRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAlertFeedbackRequest.ProtoReflect.Descriptor instead.

func (*ListAlertFeedbackRequest) GetAlertId

func (x *ListAlertFeedbackRequest) GetAlertId() string

func (*ListAlertFeedbackRequest) GetCustomerId

func (x *ListAlertFeedbackRequest) GetCustomerId() string

func (*ListAlertFeedbackRequest) GetFilter

func (x *ListAlertFeedbackRequest) GetFilter() string

func (*ListAlertFeedbackRequest) ProtoMessage

func (*ListAlertFeedbackRequest) ProtoMessage()

func (*ListAlertFeedbackRequest) ProtoReflect

func (x *ListAlertFeedbackRequest) ProtoReflect() protoreflect.Message

func (*ListAlertFeedbackRequest) Reset

func (x *ListAlertFeedbackRequest) Reset()

func (*ListAlertFeedbackRequest) String

func (x *ListAlertFeedbackRequest) String() string

type ListAlertFeedbackResponse

type ListAlertFeedbackResponse struct {

	// The list of alert feedback.
	// Feedback entries for each alert are ordered by creation time descending.
	Feedback []*AlertFeedback `protobuf:"bytes,1,rep,name=feedback,proto3" json:"feedback,omitempty"`
	// contains filtered or unexported fields
}

Response message for an alert feedback listing request.

func (*ListAlertFeedbackResponse) Descriptor deprecated

func (*ListAlertFeedbackResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAlertFeedbackResponse.ProtoReflect.Descriptor instead.

func (*ListAlertFeedbackResponse) GetFeedback

func (x *ListAlertFeedbackResponse) GetFeedback() []*AlertFeedback

func (*ListAlertFeedbackResponse) ProtoMessage

func (*ListAlertFeedbackResponse) ProtoMessage()

func (*ListAlertFeedbackResponse) ProtoReflect

func (*ListAlertFeedbackResponse) Reset

func (x *ListAlertFeedbackResponse) Reset()

func (*ListAlertFeedbackResponse) String

func (x *ListAlertFeedbackResponse) String() string

type ListAlertsRequest

type ListAlertsRequest struct {

	// Optional. 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.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Optional. The requested page size. Server may return fewer items than
	// requested. If unspecified, server picks an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	// If empty, a new iteration is started. To continue an iteration, pass in
	// the value from the previous ListAlertsResponse's
	// [next_page_token][google.apps.alertcenter.v1beta1.ListAlertsResponse.next_page_token] field.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. 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).
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. The sort order of the list results.
	// If not specified results may be returned in arbitrary order.
	// You can sort the results in descending order based on the creation
	// timestamp using `order_by="create_time desc"`.
	// Currently, supported sorting are `create_time asc`, `create_time desc`,
	// `update_time desc`
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

An alert listing request.

func (*ListAlertsRequest) Descriptor deprecated

func (*ListAlertsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAlertsRequest.ProtoReflect.Descriptor instead.

func (*ListAlertsRequest) GetCustomerId

func (x *ListAlertsRequest) GetCustomerId() string

func (*ListAlertsRequest) GetFilter

func (x *ListAlertsRequest) GetFilter() string

func (*ListAlertsRequest) GetOrderBy

func (x *ListAlertsRequest) GetOrderBy() string

func (*ListAlertsRequest) GetPageSize

func (x *ListAlertsRequest) GetPageSize() int32

func (*ListAlertsRequest) GetPageToken

func (x *ListAlertsRequest) GetPageToken() string

func (*ListAlertsRequest) ProtoMessage

func (*ListAlertsRequest) ProtoMessage()

func (*ListAlertsRequest) ProtoReflect

func (x *ListAlertsRequest) ProtoReflect() protoreflect.Message

func (*ListAlertsRequest) Reset

func (x *ListAlertsRequest) Reset()

func (*ListAlertsRequest) String

func (x *ListAlertsRequest) String() string

type ListAlertsResponse

type ListAlertsResponse struct {

	// The list of alerts.
	Alerts []*Alert `protobuf:"bytes,1,rep,name=alerts,proto3" json:"alerts,omitempty"`
	// 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][google.apps.alertcenter.v1beta1.ListAlertsRequest] to get alerts continuing from last result
	// of the current list call.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for an alert listing request.

func (*ListAlertsResponse) Descriptor deprecated

func (*ListAlertsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAlertsResponse.ProtoReflect.Descriptor instead.

func (*ListAlertsResponse) GetAlerts

func (x *ListAlertsResponse) GetAlerts() []*Alert

func (*ListAlertsResponse) GetNextPageToken

func (x *ListAlertsResponse) GetNextPageToken() string

func (*ListAlertsResponse) ProtoMessage

func (*ListAlertsResponse) ProtoMessage()

func (*ListAlertsResponse) ProtoReflect

func (x *ListAlertsResponse) ProtoReflect() protoreflect.Message

func (*ListAlertsResponse) Reset

func (x *ListAlertsResponse) Reset()

func (*ListAlertsResponse) String

func (x *ListAlertsResponse) String() string

type Settings

type Settings struct {

	// The list of notifications.
	Notifications []*Settings_Notification `protobuf:"bytes,1,rep,name=notifications,proto3" json:"notifications,omitempty"`
	// contains filtered or unexported fields
}

Customer-level settings.

func (*Settings) Descriptor deprecated

func (*Settings) Descriptor() ([]byte, []int)

Deprecated: Use Settings.ProtoReflect.Descriptor instead.

func (*Settings) GetNotifications

func (x *Settings) GetNotifications() []*Settings_Notification

func (*Settings) ProtoMessage

func (*Settings) ProtoMessage()

func (*Settings) ProtoReflect

func (x *Settings) ProtoReflect() protoreflect.Message

func (*Settings) Reset

func (x *Settings) Reset()

func (*Settings) String

func (x *Settings) String() string

type Settings_Notification

type Settings_Notification struct {

	// Exactly one destination to be specified.
	//
	// Types that are assignable to Destination:
	//	*Settings_Notification_CloudPubsubTopic_
	Destination isSettings_Notification_Destination `protobuf_oneof:"destination"`
	// contains filtered or unexported fields
}

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

func (*Settings_Notification) Descriptor deprecated

func (*Settings_Notification) Descriptor() ([]byte, []int)

Deprecated: Use Settings_Notification.ProtoReflect.Descriptor instead.

func (*Settings_Notification) GetCloudPubsubTopic

func (*Settings_Notification) GetDestination

func (m *Settings_Notification) GetDestination() isSettings_Notification_Destination

func (*Settings_Notification) ProtoMessage

func (*Settings_Notification) ProtoMessage()

func (*Settings_Notification) ProtoReflect

func (x *Settings_Notification) ProtoReflect() protoreflect.Message

func (*Settings_Notification) Reset

func (x *Settings_Notification) Reset()

func (*Settings_Notification) String

func (x *Settings_Notification) String() string

type Settings_Notification_CloudPubsubTopic

type Settings_Notification_CloudPubsubTopic struct {

	// The `name` field of a Cloud Pubsub [Topic]
	// (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic).
	TopicName string `protobuf:"bytes,1,opt,name=topic_name,json=topicName,proto3" json:"topic_name,omitempty"`
	// Optional. The format of the payload that would be sent.
	// If not specified the format will be JSON.
	PayloadFormat Settings_Notification_PayloadFormat `` /* 174-byte string literal not displayed */
	// contains filtered or unexported fields
}

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 (*Settings_Notification_CloudPubsubTopic) Descriptor deprecated

func (*Settings_Notification_CloudPubsubTopic) Descriptor() ([]byte, []int)

Deprecated: Use Settings_Notification_CloudPubsubTopic.ProtoReflect.Descriptor instead.

func (*Settings_Notification_CloudPubsubTopic) GetPayloadFormat

func (*Settings_Notification_CloudPubsubTopic) GetTopicName

func (*Settings_Notification_CloudPubsubTopic) ProtoMessage

func (*Settings_Notification_CloudPubsubTopic) ProtoReflect

func (*Settings_Notification_CloudPubsubTopic) Reset

func (*Settings_Notification_CloudPubsubTopic) String

type Settings_Notification_CloudPubsubTopic_

type Settings_Notification_CloudPubsubTopic_ struct {
	// A Google Cloud Pub/sub topic destination.
	CloudPubsubTopic *Settings_Notification_CloudPubsubTopic `protobuf:"bytes,1,opt,name=cloud_pubsub_topic,json=cloudPubsubTopic,proto3,oneof"`
}

type Settings_Notification_PayloadFormat

type Settings_Notification_PayloadFormat int32

The format of the payload.

const (
	// Payload format is not specified (will use JSON as default).
	Settings_Notification_PAYLOAD_FORMAT_UNSPECIFIED Settings_Notification_PayloadFormat = 0
	// Use JSON.
	Settings_Notification_JSON Settings_Notification_PayloadFormat = 1
)

func (Settings_Notification_PayloadFormat) Descriptor

func (Settings_Notification_PayloadFormat) Enum

func (Settings_Notification_PayloadFormat) EnumDescriptor deprecated

func (Settings_Notification_PayloadFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use Settings_Notification_PayloadFormat.Descriptor instead.

func (Settings_Notification_PayloadFormat) Number

func (Settings_Notification_PayloadFormat) String

func (Settings_Notification_PayloadFormat) Type

type UndeleteAlertRequest

type UndeleteAlertRequest struct {

	// 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 `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// Required. The identifier of the alert to undelete.
	AlertId string `protobuf:"bytes,2,opt,name=alert_id,json=alertId,proto3" json:"alert_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UndeleteAlertRequest) Descriptor deprecated

func (*UndeleteAlertRequest) Descriptor() ([]byte, []int)

Deprecated: Use UndeleteAlertRequest.ProtoReflect.Descriptor instead.

func (*UndeleteAlertRequest) GetAlertId

func (x *UndeleteAlertRequest) GetAlertId() string

func (*UndeleteAlertRequest) GetCustomerId

func (x *UndeleteAlertRequest) GetCustomerId() string

func (*UndeleteAlertRequest) ProtoMessage

func (*UndeleteAlertRequest) ProtoMessage()

func (*UndeleteAlertRequest) ProtoReflect

func (x *UndeleteAlertRequest) ProtoReflect() protoreflect.Message

func (*UndeleteAlertRequest) Reset

func (x *UndeleteAlertRequest) Reset()

func (*UndeleteAlertRequest) String

func (x *UndeleteAlertRequest) String() string

type UnimplementedAlertCenterServiceServer

type UnimplementedAlertCenterServiceServer struct {
}

UnimplementedAlertCenterServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedAlertCenterServiceServer) BatchDeleteAlerts

func (*UnimplementedAlertCenterServiceServer) BatchUndeleteAlerts

func (*UnimplementedAlertCenterServiceServer) CreateAlertFeedback

func (*UnimplementedAlertCenterServiceServer) DeleteAlert

func (*UnimplementedAlertCenterServiceServer) GetAlert

func (*UnimplementedAlertCenterServiceServer) GetAlertMetadata

func (*UnimplementedAlertCenterServiceServer) GetSettings

func (*UnimplementedAlertCenterServiceServer) ListAlertFeedback

func (*UnimplementedAlertCenterServiceServer) ListAlerts

func (*UnimplementedAlertCenterServiceServer) UndeleteAlert

func (*UnimplementedAlertCenterServiceServer) UpdateSettings

type UpdateSettingsRequest

type UpdateSettingsRequest struct {

	// Optional. 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.
	CustomerId string `protobuf:"bytes,1,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
	// The customer settings to update.
	Settings *Settings `protobuf:"bytes,2,opt,name=settings,proto3" json:"settings,omitempty"`
	// contains filtered or unexported fields
}

Update the customer level settings.

func (*UpdateSettingsRequest) Descriptor deprecated

func (*UpdateSettingsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSettingsRequest.ProtoReflect.Descriptor instead.

func (*UpdateSettingsRequest) GetCustomerId

func (x *UpdateSettingsRequest) GetCustomerId() string

func (*UpdateSettingsRequest) GetSettings

func (x *UpdateSettingsRequest) GetSettings() *Settings

func (*UpdateSettingsRequest) ProtoMessage

func (*UpdateSettingsRequest) ProtoMessage()

func (*UpdateSettingsRequest) ProtoReflect

func (x *UpdateSettingsRequest) ProtoReflect() protoreflect.Message

func (*UpdateSettingsRequest) Reset

func (x *UpdateSettingsRequest) Reset()

func (*UpdateSettingsRequest) String

func (x *UpdateSettingsRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL