Package cloud.google.com/go/chronicle/apiv1/chroniclepb (v0.1.1)

Variables

ReferenceListSyntaxType_name, ReferenceListSyntaxType_value

var (
	ReferenceListSyntaxType_name = map[int32]string{
		0: "REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED",
		1: "REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING",
		2: "REFERENCE_LIST_SYNTAX_TYPE_REGEX",
		3: "REFERENCE_LIST_SYNTAX_TYPE_CIDR",
	}
	ReferenceListSyntaxType_value = map[string]int32{
		"REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED":       0,
		"REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING": 1,
		"REFERENCE_LIST_SYNTAX_TYPE_REGEX":             2,
		"REFERENCE_LIST_SYNTAX_TYPE_CIDR":              3,
	}
)

Enum value maps for ReferenceListSyntaxType.

ReferenceListView_name, ReferenceListView_value

var (
	ReferenceListView_name = map[int32]string{
		0: "REFERENCE_LIST_VIEW_UNSPECIFIED",
		1: "REFERENCE_LIST_VIEW_BASIC",
		2: "REFERENCE_LIST_VIEW_FULL",
	}
	ReferenceListView_value = map[string]int32{
		"REFERENCE_LIST_VIEW_UNSPECIFIED": 0,
		"REFERENCE_LIST_VIEW_BASIC":       1,
		"REFERENCE_LIST_VIEW_FULL":        2,
	}
)

Enum value maps for ReferenceListView.

RunFrequency_name, RunFrequency_value

var (
	RunFrequency_name = map[int32]string{
		0: "RUN_FREQUENCY_UNSPECIFIED",
		1: "LIVE",
		2: "HOURLY",
		3: "DAILY",
	}
	RunFrequency_value = map[string]int32{
		"RUN_FREQUENCY_UNSPECIFIED": 0,
		"LIVE":                      1,
		"HOURLY":                    2,
		"DAILY":                     3,
	}
)

Enum value maps for RunFrequency.

RuleType_name, RuleType_value

var (
	RuleType_name = map[int32]string{
		0: "RULE_TYPE_UNSPECIFIED",
		1: "SINGLE_EVENT",
		2: "MULTI_EVENT",
	}
	RuleType_value = map[string]int32{
		"RULE_TYPE_UNSPECIFIED": 0,
		"SINGLE_EVENT":          1,
		"MULTI_EVENT":           2,
	}
)

Enum value maps for RuleType.

RuleView_name, RuleView_value

var (
	RuleView_name = map[int32]string{
		0: "RULE_VIEW_UNSPECIFIED",
		1: "BASIC",
		2: "FULL",
		3: "REVISION_METADATA_ONLY",
	}
	RuleView_value = map[string]int32{
		"RULE_VIEW_UNSPECIFIED":  0,
		"BASIC":                  1,
		"FULL":                   2,
		"REVISION_METADATA_ONLY": 3,
	}
)

Enum value maps for RuleView.

Rule_CompilationState_name, Rule_CompilationState_value

var (
	Rule_CompilationState_name = map[int32]string{
		0: "COMPILATION_STATE_UNSPECIFIED",
		1: "SUCCEEDED",
		2: "FAILED",
	}
	Rule_CompilationState_value = map[string]int32{
		"COMPILATION_STATE_UNSPECIFIED": 0,
		"SUCCEEDED":                     1,
		"FAILED":                        2,
	}
)

Enum value maps for Rule_CompilationState.

RuleDeployment_ExecutionState_name, RuleDeployment_ExecutionState_value

var (
	RuleDeployment_ExecutionState_name = map[int32]string{
		0: "EXECUTION_STATE_UNSPECIFIED",
		1: "DEFAULT",
		2: "LIMITED",
		3: "PAUSED",
	}
	RuleDeployment_ExecutionState_value = map[string]int32{
		"EXECUTION_STATE_UNSPECIFIED": 0,
		"DEFAULT":                     1,
		"LIMITED":                     2,
		"PAUSED":                      3,
	}
)

Enum value maps for RuleDeployment_ExecutionState.

Retrohunt_State_name, Retrohunt_State_value

var (
	Retrohunt_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "RUNNING",
		2: "DONE",
		3: "CANCELLED",
		4: "FAILED",
	}
	Retrohunt_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"RUNNING":           1,
		"DONE":              2,
		"CANCELLED":         3,
		"FAILED":            4,
	}
)

Enum value maps for Retrohunt_State.

CompilationDiagnostic_Severity_name, CompilationDiagnostic_Severity_value

var (
	CompilationDiagnostic_Severity_name = map[int32]string{
		0: "SEVERITY_UNSPECIFIED",
		1: "WARNING",
		2: "ERROR",
	}
	CompilationDiagnostic_Severity_value = map[string]int32{
		"SEVERITY_UNSPECIFIED": 0,
		"WARNING":              1,
		"ERROR":                2,
	}
)

Enum value maps for CompilationDiagnostic_Severity.

File_google_cloud_chronicle_v1_data_access_control_proto

var File_google_cloud_chronicle_v1_data_access_control_proto protoreflect.FileDescriptor

File_google_cloud_chronicle_v1_entity_proto

var File_google_cloud_chronicle_v1_entity_proto protoreflect.FileDescriptor

File_google_cloud_chronicle_v1_instance_proto

var File_google_cloud_chronicle_v1_instance_proto protoreflect.FileDescriptor

File_google_cloud_chronicle_v1_reference_list_proto

var File_google_cloud_chronicle_v1_reference_list_proto protoreflect.FileDescriptor

File_google_cloud_chronicle_v1_rule_proto

var File_google_cloud_chronicle_v1_rule_proto protoreflect.FileDescriptor

Functions

func RegisterDataAccessControlServiceServer

func RegisterDataAccessControlServiceServer(s *grpc.Server, srv DataAccessControlServiceServer)

func RegisterEntityServiceServer

func RegisterEntityServiceServer(s *grpc.Server, srv EntityServiceServer)

func RegisterInstanceServiceServer

func RegisterInstanceServiceServer(s *grpc.Server, srv InstanceServiceServer)

func RegisterReferenceListServiceServer

func RegisterReferenceListServiceServer(s *grpc.Server, srv ReferenceListServiceServer)

func RegisterRuleServiceServer

func RegisterRuleServiceServer(s *grpc.Server, srv RuleServiceServer)

CompilationDiagnostic

type CompilationDiagnostic struct {

	// Output only. The diagnostic message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// Output only. The approximate position in the rule text associated with the
	// compilation diagnostic.
	// Compilation Position may be empty.
	Position *CompilationPosition `protobuf:"bytes,2,opt,name=position,proto3" json:"position,omitempty"`
	// Output only. The severity of a rule's compilation diagnostic.
	Severity CompilationDiagnostic_Severity `protobuf:"varint,3,opt,name=severity,proto3,enum=google.cloud.chronicle.v1.CompilationDiagnostic_Severity" json:"severity,omitempty"`
	// Output only. Link to documentation that describes a diagnostic in more
	// detail.
	Uri string `protobuf:"bytes,5,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

CompilationDiagnostic represents a compilation diagnostic generated during a rule's compilation, such as a compilation error or a compilation warning.

func (*CompilationDiagnostic) Descriptor

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

Deprecated: Use CompilationDiagnostic.ProtoReflect.Descriptor instead.

func (*CompilationDiagnostic) GetMessage

func (x *CompilationDiagnostic) GetMessage() string

func (*CompilationDiagnostic) GetPosition

func (x *CompilationDiagnostic) GetPosition() *CompilationPosition

func (*CompilationDiagnostic) GetSeverity

func (*CompilationDiagnostic) GetUri

func (x *CompilationDiagnostic) GetUri() string

func (*CompilationDiagnostic) ProtoMessage

func (*CompilationDiagnostic) ProtoMessage()

func (*CompilationDiagnostic) ProtoReflect

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

func (*CompilationDiagnostic) Reset

func (x *CompilationDiagnostic) Reset()

func (*CompilationDiagnostic) String

func (x *CompilationDiagnostic) String() string

CompilationDiagnostic_Severity

type CompilationDiagnostic_Severity int32

The severity level of the compilation diagnostic.

CompilationDiagnostic_SEVERITY_UNSPECIFIED, CompilationDiagnostic_WARNING, CompilationDiagnostic_ERROR

const (
	// An unspecified severity level.
	CompilationDiagnostic_SEVERITY_UNSPECIFIED CompilationDiagnostic_Severity = 0
	// A compilation warning.
	CompilationDiagnostic_WARNING CompilationDiagnostic_Severity = 1
	// A compilation error.
	CompilationDiagnostic_ERROR CompilationDiagnostic_Severity = 2
)

func (CompilationDiagnostic_Severity) Descriptor

func (CompilationDiagnostic_Severity) Enum

func (CompilationDiagnostic_Severity) EnumDescriptor

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

Deprecated: Use CompilationDiagnostic_Severity.Descriptor instead.

func (CompilationDiagnostic_Severity) Number

func (CompilationDiagnostic_Severity) String

func (CompilationDiagnostic_Severity) Type

CompilationPosition

type CompilationPosition struct {

	// Output only. Start line number, beginning at 1.
	StartLine int32 `protobuf:"varint,1,opt,name=start_line,json=startLine,proto3" json:"start_line,omitempty"`
	// Output only. Start column number, beginning at 1.
	StartColumn int32 `protobuf:"varint,2,opt,name=start_column,json=startColumn,proto3" json:"start_column,omitempty"`
	// Output only. End line number, beginning at 1.
	EndLine int32 `protobuf:"varint,3,opt,name=end_line,json=endLine,proto3" json:"end_line,omitempty"`
	// Output only. End column number, beginning at 1.
	EndColumn int32 `protobuf:"varint,4,opt,name=end_column,json=endColumn,proto3" json:"end_column,omitempty"`
	// contains filtered or unexported fields
}

CompilationPosition represents the location of a compilation diagnostic in rule text.

func (*CompilationPosition) Descriptor

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

Deprecated: Use CompilationPosition.ProtoReflect.Descriptor instead.

func (*CompilationPosition) GetEndColumn

func (x *CompilationPosition) GetEndColumn() int32

func (*CompilationPosition) GetEndLine

func (x *CompilationPosition) GetEndLine() int32

func (*CompilationPosition) GetStartColumn

func (x *CompilationPosition) GetStartColumn() int32

func (*CompilationPosition) GetStartLine

func (x *CompilationPosition) GetStartLine() int32

func (*CompilationPosition) ProtoMessage

func (*CompilationPosition) ProtoMessage()

func (*CompilationPosition) ProtoReflect

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

func (*CompilationPosition) Reset

func (x *CompilationPosition) Reset()

func (*CompilationPosition) String

func (x *CompilationPosition) String() string

CreateDataAccessLabelRequest

type CreateDataAccessLabelRequest struct {

	// Required. The parent resource where this Data Access Label will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Data access label to create.
	DataAccessLabel *DataAccessLabel `protobuf:"bytes,2,opt,name=data_access_label,json=dataAccessLabel,proto3" json:"data_access_label,omitempty"`
	// Required. The ID to use for the data access label, which will become the
	// label's display name and the final component of the label's resource name.
	// The maximum number of characters should be 63. Regex pattern is as per AIP:
	// https://google.aip.dev/122#resource-id-segments
	DataAccessLabelId string `protobuf:"bytes,3,opt,name=data_access_label_id,json=dataAccessLabelId,proto3" json:"data_access_label_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateDataAccessLabel.

func (*CreateDataAccessLabelRequest) Descriptor

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

Deprecated: Use CreateDataAccessLabelRequest.ProtoReflect.Descriptor instead.

func (*CreateDataAccessLabelRequest) GetDataAccessLabel

func (x *CreateDataAccessLabelRequest) GetDataAccessLabel() *DataAccessLabel

func (*CreateDataAccessLabelRequest) GetDataAccessLabelId

func (x *CreateDataAccessLabelRequest) GetDataAccessLabelId() string

func (*CreateDataAccessLabelRequest) GetParent

func (x *CreateDataAccessLabelRequest) GetParent() string

func (*CreateDataAccessLabelRequest) ProtoMessage

func (*CreateDataAccessLabelRequest) ProtoMessage()

func (*CreateDataAccessLabelRequest) ProtoReflect

func (*CreateDataAccessLabelRequest) Reset

func (x *CreateDataAccessLabelRequest) Reset()

func (*CreateDataAccessLabelRequest) String

CreateDataAccessScopeRequest

type CreateDataAccessScopeRequest struct {

	// Required. The parent resource where this Data Access Scope will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Data access scope to create.
	DataAccessScope *DataAccessScope `protobuf:"bytes,2,opt,name=data_access_scope,json=dataAccessScope,proto3" json:"data_access_scope,omitempty"`
	// Required. The user provided scope id which will become the last part of the
	// name of the scope resource. Needs to be compliant with
	// https://google.aip.dev/122
	DataAccessScopeId string `protobuf:"bytes,3,opt,name=data_access_scope_id,json=dataAccessScopeId,proto3" json:"data_access_scope_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateDataAccessScope.

func (*CreateDataAccessScopeRequest) Descriptor

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

Deprecated: Use CreateDataAccessScopeRequest.ProtoReflect.Descriptor instead.

func (*CreateDataAccessScopeRequest) GetDataAccessScope

func (x *CreateDataAccessScopeRequest) GetDataAccessScope() *DataAccessScope

func (*CreateDataAccessScopeRequest) GetDataAccessScopeId

func (x *CreateDataAccessScopeRequest) GetDataAccessScopeId() string

func (*CreateDataAccessScopeRequest) GetParent

func (x *CreateDataAccessScopeRequest) GetParent() string

func (*CreateDataAccessScopeRequest) ProtoMessage

func (*CreateDataAccessScopeRequest) ProtoMessage()

func (*CreateDataAccessScopeRequest) ProtoReflect

func (*CreateDataAccessScopeRequest) Reset

func (x *CreateDataAccessScopeRequest) Reset()

func (*CreateDataAccessScopeRequest) String

CreateReferenceListRequest

type CreateReferenceListRequest struct {

	// Required. The parent resource where this reference list will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The reference list to create.
	ReferenceList *ReferenceList `protobuf:"bytes,2,opt,name=reference_list,json=referenceList,proto3" json:"reference_list,omitempty"`
	// Required. The ID to use for the reference list. This is also the display
	// name for the reference list. It must satisfy the following requirements:
	// - Starts with letter.
	// - Contains only letters, numbers and underscore.
	// - Has length less than 256.
	// - Must be unique.
	ReferenceListId string `protobuf:"bytes,3,opt,name=reference_list_id,json=referenceListId,proto3" json:"reference_list_id,omitempty"`
	// contains filtered or unexported fields
}

A request to create a reference list.

func (*CreateReferenceListRequest) Descriptor

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

Deprecated: Use CreateReferenceListRequest.ProtoReflect.Descriptor instead.

func (*CreateReferenceListRequest) GetParent

func (x *CreateReferenceListRequest) GetParent() string

func (*CreateReferenceListRequest) GetReferenceList

func (x *CreateReferenceListRequest) GetReferenceList() *ReferenceList

func (*CreateReferenceListRequest) GetReferenceListId

func (x *CreateReferenceListRequest) GetReferenceListId() string

func (*CreateReferenceListRequest) ProtoMessage

func (*CreateReferenceListRequest) ProtoMessage()

func (*CreateReferenceListRequest) ProtoReflect

func (*CreateReferenceListRequest) Reset

func (x *CreateReferenceListRequest) Reset()

func (*CreateReferenceListRequest) String

func (x *CreateReferenceListRequest) String() string

CreateRetrohuntRequest

type CreateRetrohuntRequest struct {

	// Required. The parent of retrohunt, which is a rule.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The retrohunt to create.
	Retrohunt *Retrohunt `protobuf:"bytes,2,opt,name=retrohunt,proto3" json:"retrohunt,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateRetrohunt method.

func (*CreateRetrohuntRequest) Descriptor

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

Deprecated: Use CreateRetrohuntRequest.ProtoReflect.Descriptor instead.

func (*CreateRetrohuntRequest) GetParent

func (x *CreateRetrohuntRequest) GetParent() string

func (*CreateRetrohuntRequest) GetRetrohunt

func (x *CreateRetrohuntRequest) GetRetrohunt() *Retrohunt

func (*CreateRetrohuntRequest) ProtoMessage

func (*CreateRetrohuntRequest) ProtoMessage()

func (*CreateRetrohuntRequest) ProtoReflect

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

func (*CreateRetrohuntRequest) Reset

func (x *CreateRetrohuntRequest) Reset()

func (*CreateRetrohuntRequest) String

func (x *CreateRetrohuntRequest) String() string

CreateRuleRequest

type CreateRuleRequest struct {

	// Required. The parent resource where this rule will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The rule to create.
	Rule *Rule `protobuf:"bytes,2,opt,name=rule,proto3" json:"rule,omitempty"`
	// contains filtered or unexported fields
}

Request message for CreateRule method.

func (*CreateRuleRequest) Descriptor

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

Deprecated: Use CreateRuleRequest.ProtoReflect.Descriptor instead.

func (*CreateRuleRequest) GetParent

func (x *CreateRuleRequest) GetParent() string

func (*CreateRuleRequest) GetRule

func (x *CreateRuleRequest) GetRule() *Rule

func (*CreateRuleRequest) ProtoMessage

func (*CreateRuleRequest) ProtoMessage()

func (*CreateRuleRequest) ProtoReflect

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

func (*CreateRuleRequest) Reset

func (x *CreateRuleRequest) Reset()

func (*CreateRuleRequest) String

func (x *CreateRuleRequest) String() string

CreateWatchlistRequest

type CreateWatchlistRequest struct {

	// Required. The parent resource where this watchlist will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The ID to use for the watchlist,
	// which will become the final component of the watchlist's resource name.
	//
	// This value should be 4-63 characters, and valid characters
	// are /[a-z][0-9]-/.
	WatchlistId string `protobuf:"bytes,2,opt,name=watchlist_id,json=watchlistId,proto3" json:"watchlist_id,omitempty"`
	// Required. The watchlist to create.
	Watchlist *Watchlist `protobuf:"bytes,3,opt,name=watchlist,proto3" json:"watchlist,omitempty"`
	// contains filtered or unexported fields
}

Request message for creating watchlist.

func (*CreateWatchlistRequest) Descriptor

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

Deprecated: Use CreateWatchlistRequest.ProtoReflect.Descriptor instead.

func (*CreateWatchlistRequest) GetParent

func (x *CreateWatchlistRequest) GetParent() string

func (*CreateWatchlistRequest) GetWatchlist

func (x *CreateWatchlistRequest) GetWatchlist() *Watchlist

func (*CreateWatchlistRequest) GetWatchlistId

func (x *CreateWatchlistRequest) GetWatchlistId() string

func (*CreateWatchlistRequest) ProtoMessage

func (*CreateWatchlistRequest) ProtoMessage()

func (*CreateWatchlistRequest) ProtoReflect

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

func (*CreateWatchlistRequest) Reset

func (x *CreateWatchlistRequest) Reset()

func (*CreateWatchlistRequest) String

func (x *CreateWatchlistRequest) String() string

DataAccessControlServiceClient

type DataAccessControlServiceClient interface {
	// Creates a data access label.
	// Data access labels are applied to incoming event data and selected in data
	// access scopes (another resource), and only users with scopes containing the
	// label can see data with that label. Currently, the data access label
	// resource only includes custom labels, which are labels that correspond
	// to UDM queries over event data.
	CreateDataAccessLabel(ctx context.Context, in *CreateDataAccessLabelRequest, opts ...grpc.CallOption) (*DataAccessLabel, error)
	// Gets a data access label.
	GetDataAccessLabel(ctx context.Context, in *GetDataAccessLabelRequest, opts ...grpc.CallOption) (*DataAccessLabel, error)
	// Lists all data access labels for the customer.
	ListDataAccessLabels(ctx context.Context, in *ListDataAccessLabelsRequest, opts ...grpc.CallOption) (*ListDataAccessLabelsResponse, error)
	// Updates a data access label.
	UpdateDataAccessLabel(ctx context.Context, in *UpdateDataAccessLabelRequest, opts ...grpc.CallOption) (*DataAccessLabel, error)
	// Deletes a data access label. When a label is deleted, new
	// data that enters in the system will not receive the label, but the label
	// will not be removed from old data that still refers to it.
	DeleteDataAccessLabel(ctx context.Context, in *DeleteDataAccessLabelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Creates a data access scope.
	// Data access scope is a combination of allowed and denied labels attached
	// to a permission group. If a scope has allowed labels A and B and denied
	// labels C and D, then the group of people attached to the scope
	// will have permissions to see all events labeled with A or B (or both) and
	// not labeled with either C or D.
	CreateDataAccessScope(ctx context.Context, in *CreateDataAccessScopeRequest, opts ...grpc.CallOption) (*DataAccessScope, error)
	// Retrieves an existing data access scope.
	GetDataAccessScope(ctx context.Context, in *GetDataAccessScopeRequest, opts ...grpc.CallOption) (*DataAccessScope, error)
	// Lists all existing data access scopes for the customer.
	ListDataAccessScopes(ctx context.Context, in *ListDataAccessScopesRequest, opts ...grpc.CallOption) (*ListDataAccessScopesResponse, error)
	// Updates a data access scope.
	UpdateDataAccessScope(ctx context.Context, in *UpdateDataAccessScopeRequest, opts ...grpc.CallOption) (*DataAccessScope, error)
	// Deletes a data access scope.
	DeleteDataAccessScope(ctx context.Context, in *DeleteDataAccessScopeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

DataAccessControlServiceClient is the client API for DataAccessControlService service.

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

func NewDataAccessControlServiceClient

func NewDataAccessControlServiceClient(cc grpc.ClientConnInterface) DataAccessControlServiceClient

DataAccessControlServiceServer

type DataAccessControlServiceServer interface {
	// Creates a data access label.
	// Data access labels are applied to incoming event data and selected in data
	// access scopes (another resource), and only users with scopes containing the
	// label can see data with that label. Currently, the data access label
	// resource only includes custom labels, which are labels that correspond
	// to UDM queries over event data.
	CreateDataAccessLabel(context.Context, *CreateDataAccessLabelRequest) (*DataAccessLabel, error)
	// Gets a data access label.
	GetDataAccessLabel(context.Context, *GetDataAccessLabelRequest) (*DataAccessLabel, error)
	// Lists all data access labels for the customer.
	ListDataAccessLabels(context.Context, *ListDataAccessLabelsRequest) (*ListDataAccessLabelsResponse, error)
	// Updates a data access label.
	UpdateDataAccessLabel(context.Context, *UpdateDataAccessLabelRequest) (*DataAccessLabel, error)
	// Deletes a data access label. When a label is deleted, new
	// data that enters in the system will not receive the label, but the label
	// will not be removed from old data that still refers to it.
	DeleteDataAccessLabel(context.Context, *DeleteDataAccessLabelRequest) (*emptypb.Empty, error)
	// Creates a data access scope.
	// Data access scope is a combination of allowed and denied labels attached
	// to a permission group. If a scope has allowed labels A and B and denied
	// labels C and D, then the group of people attached to the scope
	// will have permissions to see all events labeled with A or B (or both) and
	// not labeled with either C or D.
	CreateDataAccessScope(context.Context, *CreateDataAccessScopeRequest) (*DataAccessScope, error)
	// Retrieves an existing data access scope.
	GetDataAccessScope(context.Context, *GetDataAccessScopeRequest) (*DataAccessScope, error)
	// Lists all existing data access scopes for the customer.
	ListDataAccessScopes(context.Context, *ListDataAccessScopesRequest) (*ListDataAccessScopesResponse, error)
	// Updates a data access scope.
	UpdateDataAccessScope(context.Context, *UpdateDataAccessScopeRequest) (*DataAccessScope, error)
	// Deletes a data access scope.
	DeleteDataAccessScope(context.Context, *DeleteDataAccessScopeRequest) (*emptypb.Empty, error)
}

DataAccessControlServiceServer is the server API for DataAccessControlService service.

DataAccessLabel

type DataAccessLabel struct {

	// Required.
	// The definition of the data access label that determines which
	// data gets tagged with this label.
	//
	// Types that are assignable to Definition:
	//
	//	*DataAccessLabel_UdmQuery
	Definition isDataAccessLabel_Definition `protobuf_oneof:"definition"`
	// The unique resource name of the data access label.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The short name displayed for the label as it appears on event
	// data.
	DisplayName string `protobuf:"bytes,8,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The time at which the data access label was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time at which the data access label was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The user who created the data access label.
	Author string `protobuf:"bytes,6,opt,name=author,proto3" json:"author,omitempty"`
	// Output only. The user who last updated the data access label.
	LastEditor string `protobuf:"bytes,7,opt,name=last_editor,json=lastEditor,proto3" json:"last_editor,omitempty"`
	// Optional. A description of the data access label for a human reader.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

A DataAccessLabel is a label on events to define user access to data.

func (*DataAccessLabel) Descriptor

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

Deprecated: Use DataAccessLabel.ProtoReflect.Descriptor instead.

func (*DataAccessLabel) GetAuthor

func (x *DataAccessLabel) GetAuthor() string

func (*DataAccessLabel) GetCreateTime

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

func (*DataAccessLabel) GetDefinition

func (m *DataAccessLabel) GetDefinition() isDataAccessLabel_Definition

func (*DataAccessLabel) GetDescription

func (x *DataAccessLabel) GetDescription() string

func (*DataAccessLabel) GetDisplayName

func (x *DataAccessLabel) GetDisplayName() string

func (*DataAccessLabel) GetLastEditor

func (x *DataAccessLabel) GetLastEditor() string

func (*DataAccessLabel) GetName

func (x *DataAccessLabel) GetName() string

func (*DataAccessLabel) GetUdmQuery

func (x *DataAccessLabel) GetUdmQuery() string

func (*DataAccessLabel) GetUpdateTime

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

func (*DataAccessLabel) ProtoMessage

func (*DataAccessLabel) ProtoMessage()

func (*DataAccessLabel) ProtoReflect

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

func (*DataAccessLabel) Reset

func (x *DataAccessLabel) Reset()

func (*DataAccessLabel) String

func (x *DataAccessLabel) String() string

DataAccessLabelReference

type DataAccessLabelReference struct {

	// The unique identifier for the label.
	//
	// Types that are assignable to Label:
	//
	//	*DataAccessLabelReference_DataAccessLabel
	//	*DataAccessLabelReference_LogType
	//	*DataAccessLabelReference_AssetNamespace
	//	*DataAccessLabelReference_IngestionLabel
	Label isDataAccessLabelReference_Label `protobuf_oneof:"label"`
	// Output only. The display name of the label.
	// Data access label and log types's name
	// will match the display name of the resource.
	// The asset namespace will match the namespace itself.
	// The ingestion key value pair will match the key of the tuple.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

Reference object to a data access label.

func (*DataAccessLabelReference) Descriptor

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

Deprecated: Use DataAccessLabelReference.ProtoReflect.Descriptor instead.

func (*DataAccessLabelReference) GetAssetNamespace

func (x *DataAccessLabelReference) GetAssetNamespace() string

func (*DataAccessLabelReference) GetDataAccessLabel

func (x *DataAccessLabelReference) GetDataAccessLabel() string

func (*DataAccessLabelReference) GetDisplayName

func (x *DataAccessLabelReference) GetDisplayName() string

func (*DataAccessLabelReference) GetIngestionLabel

func (x *DataAccessLabelReference) GetIngestionLabel() *IngestionLabel

func (*DataAccessLabelReference) GetLabel

func (m *DataAccessLabelReference) GetLabel() isDataAccessLabelReference_Label

func (*DataAccessLabelReference) GetLogType

func (x *DataAccessLabelReference) GetLogType() string

func (*DataAccessLabelReference) ProtoMessage

func (*DataAccessLabelReference) ProtoMessage()

func (*DataAccessLabelReference) ProtoReflect

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

func (*DataAccessLabelReference) Reset

func (x *DataAccessLabelReference) Reset()

func (*DataAccessLabelReference) String

func (x *DataAccessLabelReference) String() string

DataAccessLabelReference_AssetNamespace

type DataAccessLabelReference_AssetNamespace struct {
	// The asset namespace configured in the forwarder
	// of the customer's events.
	AssetNamespace string `protobuf:"bytes,3,opt,name=asset_namespace,json=assetNamespace,proto3,oneof"`
}

DataAccessLabelReference_DataAccessLabel

type DataAccessLabelReference_DataAccessLabel struct {
	// The name of the data access label.
	DataAccessLabel string `protobuf:"bytes,1,opt,name=data_access_label,json=dataAccessLabel,proto3,oneof"`
}

DataAccessLabelReference_IngestionLabel

type DataAccessLabelReference_IngestionLabel struct {
	// The ingestion label configured in the forwarder of the customer's events.
	IngestionLabel *IngestionLabel `protobuf:"bytes,4,opt,name=ingestion_label,json=ingestionLabel,proto3,oneof"`
}

DataAccessLabelReference_LogType

type DataAccessLabelReference_LogType struct {
	// The name of the log type.
	LogType string `protobuf:"bytes,2,opt,name=log_type,json=logType,proto3,oneof"`
}

DataAccessLabel_UdmQuery

type DataAccessLabel_UdmQuery struct {
	// A UDM query over event data.
	UdmQuery string `protobuf:"bytes,3,opt,name=udm_query,json=udmQuery,proto3,oneof"`
}

DataAccessScope

type DataAccessScope struct {

	// Required. The unique full name of the data access scope.
	// The name should comply with https://google.aip.dev/122 standards.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The allowed labels for the scope.
	// Either allow_all or allowed_data_access_labels needs to be provided.
	// When provided, there has to be at least one label allowed for the scope to
	// be valid.
	// The logical operator for evaluation of the allowed labels is OR.
	// E.g.: A customer with scope with allowed labels A and B will be able
	// to see data with labeled with A or B or (A and B).
	AllowedDataAccessLabels []*DataAccessLabelReference `protobuf:"bytes,2,rep,name=allowed_data_access_labels,json=allowedDataAccessLabels,proto3" json:"allowed_data_access_labels,omitempty"`
	// Optional. The denied labels for the scope.
	// The logical operator for evaluation of the denied labels is AND.
	// E.g.: A customer with scope with denied labels A and B won't be able
	// to see data labeled with A and data labeled with B
	// and data with labels A and B.
	DeniedDataAccessLabels []*DataAccessLabelReference `protobuf:"bytes,3,rep,name=denied_data_access_labels,json=deniedDataAccessLabels,proto3" json:"denied_data_access_labels,omitempty"`
	// Output only. The name to be used for display to customers of the data
	// access scope.
	DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The time at which the data access scope was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time at which the data access scope was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The user who created the data access scope.
	Author string `protobuf:"bytes,7,opt,name=author,proto3" json:"author,omitempty"`
	// Output only. The user who last updated the data access scope.
	LastEditor string `protobuf:"bytes,8,opt,name=last_editor,json=lastEditor,proto3" json:"last_editor,omitempty"`
	// Optional. A description of the data access scope for a human reader.
	Description string `protobuf:"bytes,9,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Whether or not the scope allows all labels, allow_all and
	// allowed_data_access_labels are mutually exclusive and one of them must be
	// present. denied_data_access_labels can still be used along with allow_all.
	// When combined with denied_data_access_labels, access will be granted to all
	// data that doesn't have labels mentioned in denied_data_access_labels. E.g.:
	// A customer with scope with denied labels A and B and allow_all will be able
	// to see all data except data labeled with A and data labeled with B and data
	// with labels A and B.
	AllowAll bool `protobuf:"varint,10,opt,name=allow_all,json=allowAll,proto3" json:"allow_all,omitempty"`
	// contains filtered or unexported fields
}

A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.

func (*DataAccessScope) Descriptor

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

Deprecated: Use DataAccessScope.ProtoReflect.Descriptor instead.

func (*DataAccessScope) GetAllowAll

func (x *DataAccessScope) GetAllowAll() bool

func (*DataAccessScope) GetAllowedDataAccessLabels

func (x *DataAccessScope) GetAllowedDataAccessLabels() []*DataAccessLabelReference

func (*DataAccessScope) GetAuthor

func (x *DataAccessScope) GetAuthor() string

func (*DataAccessScope) GetCreateTime

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

func (*DataAccessScope) GetDeniedDataAccessLabels

func (x *DataAccessScope) GetDeniedDataAccessLabels() []*DataAccessLabelReference

func (*DataAccessScope) GetDescription

func (x *DataAccessScope) GetDescription() string

func (*DataAccessScope) GetDisplayName

func (x *DataAccessScope) GetDisplayName() string

func (*DataAccessScope) GetLastEditor

func (x *DataAccessScope) GetLastEditor() string

func (*DataAccessScope) GetName

func (x *DataAccessScope) GetName() string

func (*DataAccessScope) GetUpdateTime

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

func (*DataAccessScope) ProtoMessage

func (*DataAccessScope) ProtoMessage()

func (*DataAccessScope) ProtoReflect

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

func (*DataAccessScope) Reset

func (x *DataAccessScope) Reset()

func (*DataAccessScope) String

func (x *DataAccessScope) String() string

DeleteDataAccessLabelRequest

type DeleteDataAccessLabelRequest struct {

	// Required. The ID of the data access label to delete.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message to delete a data access label.

func (*DeleteDataAccessLabelRequest) Descriptor

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

Deprecated: Use DeleteDataAccessLabelRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataAccessLabelRequest) GetName

func (x *DeleteDataAccessLabelRequest) GetName() string

func (*DeleteDataAccessLabelRequest) ProtoMessage

func (*DeleteDataAccessLabelRequest) ProtoMessage()

func (*DeleteDataAccessLabelRequest) ProtoReflect

func (*DeleteDataAccessLabelRequest) Reset

func (x *DeleteDataAccessLabelRequest) Reset()

func (*DeleteDataAccessLabelRequest) String

DeleteDataAccessScopeRequest

type DeleteDataAccessScopeRequest struct {

	// Required. The ID of the data access scope to delete.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message to delete a data access scope.

func (*DeleteDataAccessScopeRequest) Descriptor

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

Deprecated: Use DeleteDataAccessScopeRequest.ProtoReflect.Descriptor instead.

func (*DeleteDataAccessScopeRequest) GetName

func (x *DeleteDataAccessScopeRequest) GetName() string

func (*DeleteDataAccessScopeRequest) ProtoMessage

func (*DeleteDataAccessScopeRequest) ProtoMessage()

func (*DeleteDataAccessScopeRequest) ProtoReflect

func (*DeleteDataAccessScopeRequest) Reset

func (x *DeleteDataAccessScopeRequest) Reset()

func (*DeleteDataAccessScopeRequest) String

DeleteRuleRequest

type DeleteRuleRequest struct {

	// Required. The name of the rule to delete. A rule revision timestamp cannot
	// be specified as part of the name, as deleting specific revisions is not
	// supported.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to true, any retrohunts and any detections associated with
	// the rule will also be deleted. If set to false, the call will only succeed
	// if the rule has no associated retrohunts, including completed retrohunts,
	// and no associated detections. Regardless of this field's value, the rule
	// deployment associated with this rule will also be deleted.
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for the DeleteRule method.

func (*DeleteRuleRequest) Descriptor

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

Deprecated: Use DeleteRuleRequest.ProtoReflect.Descriptor instead.

func (*DeleteRuleRequest) GetForce

func (x *DeleteRuleRequest) GetForce() bool

func (*DeleteRuleRequest) GetName

func (x *DeleteRuleRequest) GetName() string

func (*DeleteRuleRequest) ProtoMessage

func (*DeleteRuleRequest) ProtoMessage()

func (*DeleteRuleRequest) ProtoReflect

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

func (*DeleteRuleRequest) Reset

func (x *DeleteRuleRequest) Reset()

func (*DeleteRuleRequest) String

func (x *DeleteRuleRequest) String() string

DeleteWatchlistRequest

type DeleteWatchlistRequest struct {

	// Required. The name of the watchlist to delete.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to true, any entities under this watchlist will also be
	// deleted. (Otherwise, the request will only work if the watchlist has no
	// entities.)
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request message for deleting watchlist.

func (*DeleteWatchlistRequest) Descriptor

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

Deprecated: Use DeleteWatchlistRequest.ProtoReflect.Descriptor instead.

func (*DeleteWatchlistRequest) GetForce

func (x *DeleteWatchlistRequest) GetForce() bool

func (*DeleteWatchlistRequest) GetName

func (x *DeleteWatchlistRequest) GetName() string

func (*DeleteWatchlistRequest) ProtoMessage

func (*DeleteWatchlistRequest) ProtoMessage()

func (*DeleteWatchlistRequest) ProtoReflect

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

func (*DeleteWatchlistRequest) Reset

func (x *DeleteWatchlistRequest) Reset()

func (*DeleteWatchlistRequest) String

func (x *DeleteWatchlistRequest) String() string

EntityServiceClient

type EntityServiceClient interface {
	// Gets watchlist details for the given watchlist ID.
	GetWatchlist(ctx context.Context, in *GetWatchlistRequest, opts ...grpc.CallOption) (*Watchlist, error)
	// Lists all watchlists for the given instance.
	ListWatchlists(ctx context.Context, in *ListWatchlistsRequest, opts ...grpc.CallOption) (*ListWatchlistsResponse, error)
	// Creates a watchlist for the given instance.
	// Note that there can be at most 200 watchlists per instance.
	CreateWatchlist(ctx context.Context, in *CreateWatchlistRequest, opts ...grpc.CallOption) (*Watchlist, error)
	// Updates the watchlist for the given instance.
	UpdateWatchlist(ctx context.Context, in *UpdateWatchlistRequest, opts ...grpc.CallOption) (*Watchlist, error)
	// Deletes the watchlist for the given instance.
	DeleteWatchlist(ctx context.Context, in *DeleteWatchlistRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

EntityServiceClient is the client API for EntityService service.

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

func NewEntityServiceClient

func NewEntityServiceClient(cc grpc.ClientConnInterface) EntityServiceClient

EntityServiceServer

type EntityServiceServer interface {
	// Gets watchlist details for the given watchlist ID.
	GetWatchlist(context.Context, *GetWatchlistRequest) (*Watchlist, error)
	// Lists all watchlists for the given instance.
	ListWatchlists(context.Context, *ListWatchlistsRequest) (*ListWatchlistsResponse, error)
	// Creates a watchlist for the given instance.
	// Note that there can be at most 200 watchlists per instance.
	CreateWatchlist(context.Context, *CreateWatchlistRequest) (*Watchlist, error)
	// Updates the watchlist for the given instance.
	UpdateWatchlist(context.Context, *UpdateWatchlistRequest) (*Watchlist, error)
	// Deletes the watchlist for the given instance.
	DeleteWatchlist(context.Context, *DeleteWatchlistRequest) (*emptypb.Empty, error)
}

EntityServiceServer is the server API for EntityService service.

GetDataAccessLabelRequest

type GetDataAccessLabelRequest struct {

	// Required. The ID of the data access label to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message to retrieve a data access label.

func (*GetDataAccessLabelRequest) Descriptor

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

Deprecated: Use GetDataAccessLabelRequest.ProtoReflect.Descriptor instead.

func (*GetDataAccessLabelRequest) GetName

func (x *GetDataAccessLabelRequest) GetName() string

func (*GetDataAccessLabelRequest) ProtoMessage

func (*GetDataAccessLabelRequest) ProtoMessage()

func (*GetDataAccessLabelRequest) ProtoReflect

func (*GetDataAccessLabelRequest) Reset

func (x *GetDataAccessLabelRequest) Reset()

func (*GetDataAccessLabelRequest) String

func (x *GetDataAccessLabelRequest) String() string

GetDataAccessScopeRequest

type GetDataAccessScopeRequest struct {

	// Required. The ID of the data access scope to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message to retrieve a data access scope.

func (*GetDataAccessScopeRequest) Descriptor

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

Deprecated: Use GetDataAccessScopeRequest.ProtoReflect.Descriptor instead.

func (*GetDataAccessScopeRequest) GetName

func (x *GetDataAccessScopeRequest) GetName() string

func (*GetDataAccessScopeRequest) ProtoMessage

func (*GetDataAccessScopeRequest) ProtoMessage()

func (*GetDataAccessScopeRequest) ProtoReflect

func (*GetDataAccessScopeRequest) Reset

func (x *GetDataAccessScopeRequest) Reset()

func (*GetDataAccessScopeRequest) String

func (x *GetDataAccessScopeRequest) String() string

GetInstanceRequest

type GetInstanceRequest struct {

	// Required. The name of the instance to retrieve.
	// Format:
	// `projects/{project_id}/locations/{location}/instances/{instance}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to get a Instance.

func (*GetInstanceRequest) Descriptor

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetName

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) ProtoMessage

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect

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

func (*GetInstanceRequest) Reset

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String

func (x *GetInstanceRequest) String() string

GetReferenceListRequest

type GetReferenceListRequest struct {

	// Required. The resource name of the reference list to retrieve.
	// Format:
	// `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// How much of the ReferenceList to view. Defaults to
	// REFERENCE_LIST_VIEW_FULL.
	View ReferenceListView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.chronicle.v1.ReferenceListView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

A request to get details about a reference list.

func (*GetReferenceListRequest) Descriptor

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

Deprecated: Use GetReferenceListRequest.ProtoReflect.Descriptor instead.

func (*GetReferenceListRequest) GetName

func (x *GetReferenceListRequest) GetName() string

func (*GetReferenceListRequest) GetView

func (*GetReferenceListRequest) ProtoMessage

func (*GetReferenceListRequest) ProtoMessage()

func (*GetReferenceListRequest) ProtoReflect

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

func (*GetReferenceListRequest) Reset

func (x *GetReferenceListRequest) Reset()

func (*GetReferenceListRequest) String

func (x *GetReferenceListRequest) String() string

GetRetrohuntRequest

type GetRetrohuntRequest struct {

	// Required. The name of the retrohunt to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetRetrohunt method.

func (*GetRetrohuntRequest) Descriptor

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

Deprecated: Use GetRetrohuntRequest.ProtoReflect.Descriptor instead.

func (*GetRetrohuntRequest) GetName

func (x *GetRetrohuntRequest) GetName() string

func (*GetRetrohuntRequest) ProtoMessage

func (*GetRetrohuntRequest) ProtoMessage()

func (*GetRetrohuntRequest) ProtoReflect

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

func (*GetRetrohuntRequest) Reset

func (x *GetRetrohuntRequest) Reset()

func (*GetRetrohuntRequest) String

func (x *GetRetrohuntRequest) String() string

GetRuleDeploymentRequest

type GetRuleDeploymentRequest struct {

	// Required. The name of the rule deployment to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetRuleDeployment.

func (*GetRuleDeploymentRequest) Descriptor

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

Deprecated: Use GetRuleDeploymentRequest.ProtoReflect.Descriptor instead.

func (*GetRuleDeploymentRequest) GetName

func (x *GetRuleDeploymentRequest) GetName() string

func (*GetRuleDeploymentRequest) ProtoMessage

func (*GetRuleDeploymentRequest) ProtoMessage()

func (*GetRuleDeploymentRequest) ProtoReflect

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

func (*GetRuleDeploymentRequest) Reset

func (x *GetRuleDeploymentRequest) Reset()

func (*GetRuleDeploymentRequest) String

func (x *GetRuleDeploymentRequest) String() string

GetRuleRequest

type GetRuleRequest struct {

	// Required. The name of the rule to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The view field indicates the scope of fields to populate for the Rule being
	// returned. If unspecified, defaults to FULL.
	View RuleView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.chronicle.v1.RuleView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetRule method.

func (*GetRuleRequest) Descriptor

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

Deprecated: Use GetRuleRequest.ProtoReflect.Descriptor instead.

func (*GetRuleRequest) GetName

func (x *GetRuleRequest) GetName() string

func (*GetRuleRequest) GetView

func (x *GetRuleRequest) GetView() RuleView

func (*GetRuleRequest) ProtoMessage

func (*GetRuleRequest) ProtoMessage()

func (*GetRuleRequest) ProtoReflect

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

func (*GetRuleRequest) Reset

func (x *GetRuleRequest) Reset()

func (*GetRuleRequest) String

func (x *GetRuleRequest) String() string

GetWatchlistRequest

type GetWatchlistRequest struct {

	// Required. The parent, which owns this collection of watchlists.
	// The name of the watchlist to retrieve.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for getting a watchlist.

func (*GetWatchlistRequest) Descriptor

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

Deprecated: Use GetWatchlistRequest.ProtoReflect.Descriptor instead.

func (*GetWatchlistRequest) GetName

func (x *GetWatchlistRequest) GetName() string

func (*GetWatchlistRequest) ProtoMessage

func (*GetWatchlistRequest) ProtoMessage()

func (*GetWatchlistRequest) ProtoReflect

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

func (*GetWatchlistRequest) Reset

func (x *GetWatchlistRequest) Reset()

func (*GetWatchlistRequest) String

func (x *GetWatchlistRequest) String() string

IngestionLabel

type IngestionLabel struct {

	// Required. The key of the ingestion label. Always required.
	IngestionLabelKey string `protobuf:"bytes,1,opt,name=ingestion_label_key,json=ingestionLabelKey,proto3" json:"ingestion_label_key,omitempty"`
	// Optional. The value of the ingestion label. Optional. An object
	// with no provided value and some key provided would match
	// against the given key and ANY value.
	IngestionLabelValue string `protobuf:"bytes,2,opt,name=ingestion_label_value,json=ingestionLabelValue,proto3" json:"ingestion_label_value,omitempty"`
	// contains filtered or unexported fields
}

Representation of an ingestion label type.

func (*IngestionLabel) Descriptor

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

Deprecated: Use IngestionLabel.ProtoReflect.Descriptor instead.

func (*IngestionLabel) GetIngestionLabelKey

func (x *IngestionLabel) GetIngestionLabelKey() string

func (*IngestionLabel) GetIngestionLabelValue

func (x *IngestionLabel) GetIngestionLabelValue() string

func (*IngestionLabel) ProtoMessage

func (*IngestionLabel) ProtoMessage()

func (*IngestionLabel) ProtoReflect

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

func (*IngestionLabel) Reset

func (x *IngestionLabel) Reset()

func (*IngestionLabel) String

func (x *IngestionLabel) String() string

InputsUsed

type InputsUsed struct {

	// Optional. Whether the rule queries UDM events.
	UsesUdm bool `protobuf:"varint,1,opt,name=uses_udm,json=usesUdm,proto3" json:"uses_udm,omitempty"`
	// Optional. Whether the rule queries entity events.
	UsesEntity bool `protobuf:"varint,2,opt,name=uses_entity,json=usesEntity,proto3" json:"uses_entity,omitempty"`
	// Optional. Whether the rule queries detections.
	UsesDetection bool `protobuf:"varint,3,opt,name=uses_detection,json=usesDetection,proto3" json:"uses_detection,omitempty"`
	// contains filtered or unexported fields
}

InputsUsed is a convenience field that tells us which sources of events (if any) were used in the rule. NEXT TAG: 4

func (*InputsUsed) Descriptor

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

Deprecated: Use InputsUsed.ProtoReflect.Descriptor instead.

func (*InputsUsed) GetUsesDetection

func (x *InputsUsed) GetUsesDetection() bool

func (*InputsUsed) GetUsesEntity

func (x *InputsUsed) GetUsesEntity() bool

func (*InputsUsed) GetUsesUdm

func (x *InputsUsed) GetUsesUdm() bool

func (*InputsUsed) ProtoMessage

func (*InputsUsed) ProtoMessage()

func (*InputsUsed) ProtoReflect

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

func (*InputsUsed) Reset

func (x *InputsUsed) Reset()

func (*InputsUsed) String

func (x *InputsUsed) String() string

Instance

type Instance struct {

	// Identifier. The resource name of this instance.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A Instance represents an instantiation of the Instance product.

func (*Instance) Descriptor

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

InstanceServiceClient

type InstanceServiceClient interface {
	// Gets a Instance.
	GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
}

InstanceServiceClient is the client API for InstanceService service.

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

func NewInstanceServiceClient

func NewInstanceServiceClient(cc grpc.ClientConnInterface) InstanceServiceClient

InstanceServiceServer

type InstanceServiceServer interface {
	// Gets a Instance.
	GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
}

InstanceServiceServer is the server API for InstanceService service.

ListDataAccessLabelsRequest

type ListDataAccessLabelsRequest struct {

	// Required. The parent resource where this data access label will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of data access labels to return. The service may return
	// fewer than this value. If unspecified, at most 100 data access labels will
	// be returned. The maximum value is 1000; values above 1000 will be coerced
	// to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListDataAccessLabelsRequest` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter which should follow the guidelines of AIP-160.
	// Supports filtering on all fieds of DataAccessLabel and all operations as
	// mentioned in https://google.aip.dev/160.
	// example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
	// display_name:\"-21-1\"".
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListDataAccessLabels.

func (*ListDataAccessLabelsRequest) Descriptor

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

Deprecated: Use ListDataAccessLabelsRequest.ProtoReflect.Descriptor instead.

func (*ListDataAccessLabelsRequest) GetFilter

func (x *ListDataAccessLabelsRequest) GetFilter() string

func (*ListDataAccessLabelsRequest) GetPageSize

func (x *ListDataAccessLabelsRequest) GetPageSize() int32

func (*ListDataAccessLabelsRequest) GetPageToken

func (x *ListDataAccessLabelsRequest) GetPageToken() string

func (*ListDataAccessLabelsRequest) GetParent

func (x *ListDataAccessLabelsRequest) GetParent() string

func (*ListDataAccessLabelsRequest) ProtoMessage

func (*ListDataAccessLabelsRequest) ProtoMessage()

func (*ListDataAccessLabelsRequest) ProtoReflect

func (*ListDataAccessLabelsRequest) Reset

func (x *ListDataAccessLabelsRequest) Reset()

func (*ListDataAccessLabelsRequest) String

func (x *ListDataAccessLabelsRequest) String() string

ListDataAccessLabelsResponse

type ListDataAccessLabelsResponse struct {

	// List of data access labels.
	DataAccessLabels []*DataAccessLabel `protobuf:"bytes,1,rep,name=data_access_labels,json=dataAccessLabels,proto3" json:"data_access_labels,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	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 ListDataAccessLabels.

func (*ListDataAccessLabelsResponse) Descriptor

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

Deprecated: Use ListDataAccessLabelsResponse.ProtoReflect.Descriptor instead.

func (*ListDataAccessLabelsResponse) GetDataAccessLabels

func (x *ListDataAccessLabelsResponse) GetDataAccessLabels() []*DataAccessLabel

func (*ListDataAccessLabelsResponse) GetNextPageToken

func (x *ListDataAccessLabelsResponse) GetNextPageToken() string

func (*ListDataAccessLabelsResponse) ProtoMessage

func (*ListDataAccessLabelsResponse) ProtoMessage()

func (*ListDataAccessLabelsResponse) ProtoReflect

func (*ListDataAccessLabelsResponse) Reset

func (x *ListDataAccessLabelsResponse) Reset()

func (*ListDataAccessLabelsResponse) String

ListDataAccessScopesRequest

type ListDataAccessScopesRequest struct {

	// Required. The parent resource where this data access scope will be created.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of data access scopes to return. The service may return
	// fewer than this value. If unspecified, at most 100 data access scopes will
	// be returned. The maximum value is 1000; values above 1000 will be coerced
	// to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListDataAccessScopesRequest` call.
	// Provide this to retrieve the subsequent page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter which should follow the guidelines of AIP-160.
	// Supports filtering on all fieds of DataAccessScope and all operations as
	// mentioned in https://google.aip.dev/160.
	// example filter: "create_time greater than \"2023-04-21T11:30:00-04:00\" OR
	// display_name:\"-21-1\"".
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListDataAccessScopes.

func (*ListDataAccessScopesRequest) Descriptor

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

Deprecated: Use ListDataAccessScopesRequest.ProtoReflect.Descriptor instead.

func (*ListDataAccessScopesRequest) GetFilter

func (x *ListDataAccessScopesRequest) GetFilter() string

func (*ListDataAccessScopesRequest) GetPageSize

func (x *ListDataAccessScopesRequest) GetPageSize() int32

func (*ListDataAccessScopesRequest) GetPageToken

func (x *ListDataAccessScopesRequest) GetPageToken() string

func (*ListDataAccessScopesRequest) GetParent

func (x *ListDataAccessScopesRequest) GetParent() string

func (*ListDataAccessScopesRequest) ProtoMessage

func (*ListDataAccessScopesRequest) ProtoMessage()

func (*ListDataAccessScopesRequest) ProtoReflect

func (*ListDataAccessScopesRequest) Reset

func (x *ListDataAccessScopesRequest) Reset()

func (*ListDataAccessScopesRequest) String

func (x *ListDataAccessScopesRequest) String() string

ListDataAccessScopesResponse

type ListDataAccessScopesResponse struct {

	// List of data access scopes.
	DataAccessScopes []*DataAccessScope `protobuf:"bytes,1,rep,name=data_access_scopes,json=dataAccessScopes,proto3" json:"data_access_scopes,omitempty"`
	// Whether or not global scope is granted to the user.
	GlobalDataAccessScopeGranted *bool `protobuf:"varint,3,opt,name=global_data_access_scope_granted,json=globalDataAccessScopeGranted,proto3,oneof" json:"global_data_access_scope_granted,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	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 ListDataAccessScopes.

func (*ListDataAccessScopesResponse) Descriptor

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

Deprecated: Use ListDataAccessScopesResponse.ProtoReflect.Descriptor instead.

func (*ListDataAccessScopesResponse) GetDataAccessScopes

func (x *ListDataAccessScopesResponse) GetDataAccessScopes() []*DataAccessScope

func (*ListDataAccessScopesResponse) GetGlobalDataAccessScopeGranted

func (x *ListDataAccessScopesResponse) GetGlobalDataAccessScopeGranted() bool

func (*ListDataAccessScopesResponse) GetNextPageToken

func (x *ListDataAccessScopesResponse) GetNextPageToken() string

func (*ListDataAccessScopesResponse) ProtoMessage

func (*ListDataAccessScopesResponse) ProtoMessage()

func (*ListDataAccessScopesResponse) ProtoReflect

func (*ListDataAccessScopesResponse) Reset

func (x *ListDataAccessScopesResponse) Reset()

func (*ListDataAccessScopesResponse) String

ListReferenceListsRequest

type ListReferenceListsRequest struct {

	// Required. The parent, which owns this collection of reference lists.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of reference lists to return.
	// The service may return fewer than this value.
	// If unspecified, at most 100 reference lists will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListReferenceLists` call.
	// Provide this to retrieve the subsequent page.
	// When paginating, all other parameters provided to `ListReferenceLists` must
	// match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// How much of each ReferenceList to view. Defaults to
	// REFERENCE_LIST_VIEW_BASIC.
	View ReferenceListView `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.chronicle.v1.ReferenceListView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

A request for a list of reference lists.

func (*ListReferenceListsRequest) Descriptor

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

Deprecated: Use ListReferenceListsRequest.ProtoReflect.Descriptor instead.

func (*ListReferenceListsRequest) GetPageSize

func (x *ListReferenceListsRequest) GetPageSize() int32

func (*ListReferenceListsRequest) GetPageToken

func (x *ListReferenceListsRequest) GetPageToken() string

func (*ListReferenceListsRequest) GetParent

func (x *ListReferenceListsRequest) GetParent() string

func (*ListReferenceListsRequest) GetView

func (*ListReferenceListsRequest) ProtoMessage

func (*ListReferenceListsRequest) ProtoMessage()

func (*ListReferenceListsRequest) ProtoReflect

func (*ListReferenceListsRequest) Reset

func (x *ListReferenceListsRequest) Reset()

func (*ListReferenceListsRequest) String

func (x *ListReferenceListsRequest) String() string

ListReferenceListsResponse

type ListReferenceListsResponse struct {

	// The reference lists.
	// Ordered in ascending alphabetical order by name.
	ReferenceLists []*ReferenceList `protobuf:"bytes,1,rep,name=reference_lists,json=referenceLists,proto3" json:"reference_lists,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

A response to a request for a list of reference lists.

func (*ListReferenceListsResponse) Descriptor

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

Deprecated: Use ListReferenceListsResponse.ProtoReflect.Descriptor instead.

func (*ListReferenceListsResponse) GetNextPageToken

func (x *ListReferenceListsResponse) GetNextPageToken() string

func (*ListReferenceListsResponse) GetReferenceLists

func (x *ListReferenceListsResponse) GetReferenceLists() []*ReferenceList

func (*ListReferenceListsResponse) ProtoMessage

func (*ListReferenceListsResponse) ProtoMessage()

func (*ListReferenceListsResponse) ProtoReflect

func (*ListReferenceListsResponse) Reset

func (x *ListReferenceListsResponse) Reset()

func (*ListReferenceListsResponse) String

func (x *ListReferenceListsResponse) String() string

ListRetrohuntsRequest

type ListRetrohuntsRequest struct {

	// Required. The rule that the retrohunts belong to.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of retrohunt to return. The service may return fewer
	// than this value. If unspecified, at most 100 retrohunts will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to
	// 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListRetrohunts` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListRetrohunts` must
	// match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A filter that can be used to retrieve specific rule deployments.
	// The following fields are filterable:
	// state
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListRetrohunts method.

func (*ListRetrohuntsRequest) Descriptor

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

Deprecated: Use ListRetrohuntsRequest.ProtoReflect.Descriptor instead.

func (*ListRetrohuntsRequest) GetFilter

func (x *ListRetrohuntsRequest) GetFilter() string

func (*ListRetrohuntsRequest) GetPageSize

func (x *ListRetrohuntsRequest) GetPageSize() int32

func (*ListRetrohuntsRequest) GetPageToken

func (x *ListRetrohuntsRequest) GetPageToken() string

func (*ListRetrohuntsRequest) GetParent

func (x *ListRetrohuntsRequest) GetParent() string

func (*ListRetrohuntsRequest) ProtoMessage

func (*ListRetrohuntsRequest) ProtoMessage()

func (*ListRetrohuntsRequest) ProtoReflect

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

func (*ListRetrohuntsRequest) Reset

func (x *ListRetrohuntsRequest) Reset()

func (*ListRetrohuntsRequest) String

func (x *ListRetrohuntsRequest) String() string

ListRetrohuntsResponse

type ListRetrohuntsResponse struct {

	// The retrohunts from the specified rule.
	Retrohunts []*Retrohunt `protobuf:"bytes,1,rep,name=retrohunts,proto3" json:"retrohunts,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	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 ListRetrohunts method.

func (*ListRetrohuntsResponse) Descriptor

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

Deprecated: Use ListRetrohuntsResponse.ProtoReflect.Descriptor instead.

func (*ListRetrohuntsResponse) GetNextPageToken

func (x *ListRetrohuntsResponse) GetNextPageToken() string

func (*ListRetrohuntsResponse) GetRetrohunts

func (x *ListRetrohuntsResponse) GetRetrohunts() []*Retrohunt

func (*ListRetrohuntsResponse) ProtoMessage

func (*ListRetrohuntsResponse) ProtoMessage()

func (*ListRetrohuntsResponse) ProtoReflect

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

func (*ListRetrohuntsResponse) Reset

func (x *ListRetrohuntsResponse) Reset()

func (*ListRetrohuntsResponse) String

func (x *ListRetrohuntsResponse) String() string

ListRuleDeploymentsRequest

type ListRuleDeploymentsRequest struct {

	// Required. The collection of all parents which own all rule deployments. The
	// "-" wildcard token must be used as the rule identifier in the resource
	// path. Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/-`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of rule deployments to return. The service may return
	// fewer than this value. If unspecified, at most 100 rule deployments will be
	// returned. The maximum value is 1000; values above 1000 will be coerced to
	// 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListRuleDeployments` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListRuleDeployments`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A filter that can be used to retrieve specific rule deployments.
	// The following fields are filterable:
	// archived, name
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListRuleDeployments.

func (*ListRuleDeploymentsRequest) Descriptor

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

Deprecated: Use ListRuleDeploymentsRequest.ProtoReflect.Descriptor instead.

func (*ListRuleDeploymentsRequest) GetFilter

func (x *ListRuleDeploymentsRequest) GetFilter() string

func (*ListRuleDeploymentsRequest) GetPageSize

func (x *ListRuleDeploymentsRequest) GetPageSize() int32

func (*ListRuleDeploymentsRequest) GetPageToken

func (x *ListRuleDeploymentsRequest) GetPageToken() string

func (*ListRuleDeploymentsRequest) GetParent

func (x *ListRuleDeploymentsRequest) GetParent() string

func (*ListRuleDeploymentsRequest) ProtoMessage

func (*ListRuleDeploymentsRequest) ProtoMessage()

func (*ListRuleDeploymentsRequest) ProtoReflect

func (*ListRuleDeploymentsRequest) Reset

func (x *ListRuleDeploymentsRequest) Reset()

func (*ListRuleDeploymentsRequest) String

func (x *ListRuleDeploymentsRequest) String() string

ListRuleDeploymentsResponse

type ListRuleDeploymentsResponse struct {

	// The rule deployments from all rules.
	RuleDeployments []*RuleDeployment `protobuf:"bytes,1,rep,name=rule_deployments,json=ruleDeployments,proto3" json:"rule_deployments,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	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 ListRuleDeployments.

func (*ListRuleDeploymentsResponse) Descriptor

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

Deprecated: Use ListRuleDeploymentsResponse.ProtoReflect.Descriptor instead.

func (*ListRuleDeploymentsResponse) GetNextPageToken

func (x *ListRuleDeploymentsResponse) GetNextPageToken() string

func (*ListRuleDeploymentsResponse) GetRuleDeployments

func (x *ListRuleDeploymentsResponse) GetRuleDeployments() []*RuleDeployment

func (*ListRuleDeploymentsResponse) ProtoMessage

func (*ListRuleDeploymentsResponse) ProtoMessage()

func (*ListRuleDeploymentsResponse) ProtoReflect

func (*ListRuleDeploymentsResponse) Reset

func (x *ListRuleDeploymentsResponse) Reset()

func (*ListRuleDeploymentsResponse) String

func (x *ListRuleDeploymentsResponse) String() string

ListRuleRevisionsRequest

type ListRuleRevisionsRequest struct {

	// Required. The name of the rule to list revisions for.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The maximum number of revisions to return per page. The service may return
	// fewer than this value. If unspecified, at most 100 revisions will be
	// returned. The maximum value is 1000; values above 1000 will be coerced to
	// 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The page token, received from a previous `ListRuleRevisions` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListRuleRevisions`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// The view field indicates the scope of fields to populate for the revision
	// being returned. If unspecified, defaults to BASIC.
	View RuleView `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.chronicle.v1.RuleView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListRuleRevisions method.

func (*ListRuleRevisionsRequest) Descriptor

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

Deprecated: Use ListRuleRevisionsRequest.ProtoReflect.Descriptor instead.

func (*ListRuleRevisionsRequest) GetName

func (x *ListRuleRevisionsRequest) GetName() string

func (*ListRuleRevisionsRequest) GetPageSize

func (x *ListRuleRevisionsRequest) GetPageSize() int32

func (*ListRuleRevisionsRequest) GetPageToken

func (x *ListRuleRevisionsRequest) GetPageToken() string

func (*ListRuleRevisionsRequest) GetView

func (x *ListRuleRevisionsRequest) GetView() RuleView

func (*ListRuleRevisionsRequest) ProtoMessage

func (*ListRuleRevisionsRequest) ProtoMessage()

func (*ListRuleRevisionsRequest) ProtoReflect

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

func (*ListRuleRevisionsRequest) Reset

func (x *ListRuleRevisionsRequest) Reset()

func (*ListRuleRevisionsRequest) String

func (x *ListRuleRevisionsRequest) String() string

ListRuleRevisionsResponse

type ListRuleRevisionsResponse struct {

	// The revisions of the rule.
	Rules []*Rule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// A token that can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	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 ListRuleRevisions method.

func (*ListRuleRevisionsResponse) Descriptor

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

Deprecated: Use ListRuleRevisionsResponse.ProtoReflect.Descriptor instead.

func (*ListRuleRevisionsResponse) GetNextPageToken

func (x *ListRuleRevisionsResponse) GetNextPageToken() string

func (*ListRuleRevisionsResponse) GetRules

func (x *ListRuleRevisionsResponse) GetRules() []*Rule

func (*ListRuleRevisionsResponse) ProtoMessage

func (*ListRuleRevisionsResponse) ProtoMessage()

func (*ListRuleRevisionsResponse) ProtoReflect

func (*ListRuleRevisionsResponse) Reset

func (x *ListRuleRevisionsResponse) Reset()

func (*ListRuleRevisionsResponse) String

func (x *ListRuleRevisionsResponse) String() string

ListRulesRequest

type ListRulesRequest struct {

	// Required. The parent, which owns this collection of rules.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of rules to return. The service may return fewer than
	// this value. If unspecified, at most 100 rules will be returned. The
	// maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListRules` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListRules`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// view indicates the scope of fields to populate for the Rule being returned.
	// If unspecified, defaults to BASIC.
	View RuleView `protobuf:"varint,4,opt,name=view,proto3,enum=google.cloud.chronicle.v1.RuleView" json:"view,omitempty"`
	// Only the following filters are allowed:
	// "reference_lists:{reference_list_name}"
	// "data_tables:{data_table_name}"
	// "display_name:{display_name}"
	Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for ListRules method.

func (*ListRulesRequest) Descriptor

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

Deprecated: Use ListRulesRequest.ProtoReflect.Descriptor instead.

func (*ListRulesRequest) GetFilter

func (x *ListRulesRequest) GetFilter() string

func (*ListRulesRequest) GetPageSize

func (x *ListRulesRequest) GetPageSize() int32

func (*ListRulesRequest) GetPageToken

func (x *ListRulesRequest) GetPageToken() string

func (*ListRulesRequest) GetParent

func (x *ListRulesRequest) GetParent() string

func (*ListRulesRequest) GetView

func (x *ListRulesRequest) GetView() RuleView

func (*ListRulesRequest) ProtoMessage

func (*ListRulesRequest) ProtoMessage()

func (*ListRulesRequest) ProtoReflect

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

func (*ListRulesRequest) Reset

func (x *ListRulesRequest) Reset()

func (*ListRulesRequest) String

func (x *ListRulesRequest) String() string

ListRulesResponse

type ListRulesResponse struct {

	// The rules from the specified instance.
	Rules []*Rule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	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 ListRules method.

func (*ListRulesResponse) Descriptor

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

Deprecated: Use ListRulesResponse.ProtoReflect.Descriptor instead.

func (*ListRulesResponse) GetNextPageToken

func (x *ListRulesResponse) GetNextPageToken() string

func (*ListRulesResponse) GetRules

func (x *ListRulesResponse) GetRules() []*Rule

func (*ListRulesResponse) ProtoMessage

func (*ListRulesResponse) ProtoMessage()

func (*ListRulesResponse) ProtoReflect

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

func (*ListRulesResponse) Reset

func (x *ListRulesResponse) Reset()

func (*ListRulesResponse) String

func (x *ListRulesResponse) String() string

ListWatchlistsRequest

type ListWatchlistsRequest struct {

	// Required. The parent, which owns this collection of watchlists.
	// Format: `projects/{project}/locations/{location}/instances/{instance}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of watchlists to return.
	// The service may return fewer than this value.
	// If unspecified, at most 200 watchlists will be returned.
	// The maximum value is 200; values above 200 will be coerced to 200.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListWatchlists` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// `ListWatchlists` must match the call that provided the page
	// token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Which watchlist to return in aip.dev/160 form.
	// Currently, only the following filters are supported:
	// - `watchlist_user_preferences.pinned=true`
	// - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE])`
	// - `has_entity([ENTITY_INDICATOR],[ENTITY_TYPE],[NAMESPACE])`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for listing watchlists.

func (*ListWatchlistsRequest) Descriptor

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

Deprecated: Use ListWatchlistsRequest.ProtoReflect.Descriptor instead.

func (*ListWatchlistsRequest) GetFilter

func (x *ListWatchlistsRequest) GetFilter() string

func (*ListWatchlistsRequest) GetPageSize

func (x *ListWatchlistsRequest) GetPageSize() int32

func (*ListWatchlistsRequest) GetPageToken

func (x *ListWatchlistsRequest) GetPageToken() string

func (*ListWatchlistsRequest) GetParent

func (x *ListWatchlistsRequest) GetParent() string

func (*ListWatchlistsRequest) ProtoMessage

func (*ListWatchlistsRequest) ProtoMessage()

func (*ListWatchlistsRequest) ProtoReflect

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

func (*ListWatchlistsRequest) Reset

func (x *ListWatchlistsRequest) Reset()

func (*ListWatchlistsRequest) String

func (x *ListWatchlistsRequest) String() string

ListWatchlistsResponse

type ListWatchlistsResponse struct {

	// Optional. The watchlists from the specified instance.
	Watchlists []*Watchlist `protobuf:"bytes,1,rep,name=watchlists,proto3" json:"watchlists,omitempty"`
	// Optional. A token, which can be sent as `page_token` to retrieve the next
	// page. If this field is omitted, there are no subsequent pages.
	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 listing watchlists.

func (*ListWatchlistsResponse) Descriptor

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

Deprecated: Use ListWatchlistsResponse.ProtoReflect.Descriptor instead.

func (*ListWatchlistsResponse) GetNextPageToken

func (x *ListWatchlistsResponse) GetNextPageToken() string

func (*ListWatchlistsResponse) GetWatchlists

func (x *ListWatchlistsResponse) GetWatchlists() []*Watchlist

func (*ListWatchlistsResponse) ProtoMessage

func (*ListWatchlistsResponse) ProtoMessage()

func (*ListWatchlistsResponse) ProtoReflect

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

func (*ListWatchlistsResponse) Reset

func (x *ListWatchlistsResponse) Reset()

func (*ListWatchlistsResponse) String

func (x *ListWatchlistsResponse) String() string

ReferenceList

type ReferenceList struct {

	// Identifier. The resource name of the reference list.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The unique display name of the reference list.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The timestamp when the reference list was last updated.
	RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
	// Required. A user-provided description of the reference list.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Required. The entries of the reference list.
	// When listed, they are returned in the order that was specified at creation
	// or update. The combined size of the values of the reference list may not
	// exceed 6MB.
	// This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
	Entries []*ReferenceListEntry `protobuf:"bytes,5,rep,name=entries,proto3" json:"entries,omitempty"`
	// Output only. The resource names for the associated self-authored Rules that
	// use this reference list. This is returned only when the view is
	// REFERENCE_LIST_VIEW_FULL.
	Rules []string `protobuf:"bytes,6,rep,name=rules,proto3" json:"rules,omitempty"`
	// Required. The syntax type indicating how list entries should be validated.
	SyntaxType ReferenceListSyntaxType `protobuf:"varint,8,opt,name=syntax_type,json=syntaxType,proto3,enum=google.cloud.chronicle.v1.ReferenceListSyntaxType" json:"syntax_type,omitempty"`
	// Output only. The count of self-authored rules using the reference list.
	RuleAssociationsCount int32 `protobuf:"varint,9,opt,name=rule_associations_count,json=ruleAssociationsCount,proto3" json:"rule_associations_count,omitempty"`
	// The scope info of the reference list.
	// During reference list creation, if this field is not set, the reference
	// list without scopes (an unscoped list) will be created for an unscoped
	// user. For a scoped user, this field must be set. During reference list
	// update, if scope_info is requested to be updated, this field must be set.
	ScopeInfo *ScopeInfo `protobuf:"bytes,11,opt,name=scope_info,json=scopeInfo,proto3" json:"scope_info,omitempty"`
	// contains filtered or unexported fields
}

A reference list. Reference lists are user-defined lists of values which users can use in multiple Rules.

func (*ReferenceList) Descriptor

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

Deprecated: Use ReferenceList.ProtoReflect.Descriptor instead.

func (*ReferenceList) GetDescription

func (x *ReferenceList) GetDescription() string

func (*ReferenceList) GetDisplayName

func (x *ReferenceList) GetDisplayName() string

func (*ReferenceList) GetEntries

func (x *ReferenceList) GetEntries() []*ReferenceListEntry

func (*ReferenceList) GetName

func (x *ReferenceList) GetName() string

func (*ReferenceList) GetRevisionCreateTime

func (x *ReferenceList) GetRevisionCreateTime() *timestamppb.Timestamp

func (*ReferenceList) GetRuleAssociationsCount

func (x *ReferenceList) GetRuleAssociationsCount() int32

func (*ReferenceList) GetRules

func (x *ReferenceList) GetRules() []string

func (*ReferenceList) GetScopeInfo

func (x *ReferenceList) GetScopeInfo() *ScopeInfo

func (*ReferenceList) GetSyntaxType

func (x *ReferenceList) GetSyntaxType() ReferenceListSyntaxType

func (*ReferenceList) ProtoMessage

func (*ReferenceList) ProtoMessage()

func (*ReferenceList) ProtoReflect

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

func (*ReferenceList) Reset

func (x *ReferenceList) Reset()

func (*ReferenceList) String

func (x *ReferenceList) String() string

ReferenceListEntry

type ReferenceListEntry struct {

	// Required. The value of the entry. Maximum length is 512 characters.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

An entry in a reference list.

func (*ReferenceListEntry) Descriptor

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

Deprecated: Use ReferenceListEntry.ProtoReflect.Descriptor instead.

func (*ReferenceListEntry) GetValue

func (x *ReferenceListEntry) GetValue() string

func (*ReferenceListEntry) ProtoMessage

func (*ReferenceListEntry) ProtoMessage()

func (*ReferenceListEntry) ProtoReflect

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

func (*ReferenceListEntry) Reset

func (x *ReferenceListEntry) Reset()

func (*ReferenceListEntry) String

func (x *ReferenceListEntry) String() string

ReferenceListScope

type ReferenceListScope struct {

	// Optional. The list of scope names of the reference list. The scope names
	// should be full resource names and should be of the format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}`.
	ScopeNames []string `protobuf:"bytes,1,rep,name=scope_names,json=scopeNames,proto3" json:"scope_names,omitempty"`
	// contains filtered or unexported fields
}

ReferenceListScope specifies the list of scope names of the reference list.

func (*ReferenceListScope) Descriptor

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

Deprecated: Use ReferenceListScope.ProtoReflect.Descriptor instead.

func (*ReferenceListScope) GetScopeNames

func (x *ReferenceListScope) GetScopeNames() []string

func (*ReferenceListScope) ProtoMessage

func (*ReferenceListScope) ProtoMessage()

func (*ReferenceListScope) ProtoReflect

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

func (*ReferenceListScope) Reset

func (x *ReferenceListScope) Reset()

func (*ReferenceListScope) String

func (x *ReferenceListScope) String() string

ReferenceListServiceClient

type ReferenceListServiceClient interface {
	// Gets a single reference list.
	GetReferenceList(ctx context.Context, in *GetReferenceListRequest, opts ...grpc.CallOption) (*ReferenceList, error)
	// Lists a collection of reference lists.
	ListReferenceLists(ctx context.Context, in *ListReferenceListsRequest, opts ...grpc.CallOption) (*ListReferenceListsResponse, error)
	// Creates a new reference list.
	CreateReferenceList(ctx context.Context, in *CreateReferenceListRequest, opts ...grpc.CallOption) (*ReferenceList, error)
	// Updates an existing reference list.
	UpdateReferenceList(ctx context.Context, in *UpdateReferenceListRequest, opts ...grpc.CallOption) (*ReferenceList, error)
}

ReferenceListServiceClient is the client API for ReferenceListService service.

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

func NewReferenceListServiceClient

func NewReferenceListServiceClient(cc grpc.ClientConnInterface) ReferenceListServiceClient

ReferenceListServiceServer

type ReferenceListServiceServer interface {
	// Gets a single reference list.
	GetReferenceList(context.Context, *GetReferenceListRequest) (*ReferenceList, error)
	// Lists a collection of reference lists.
	ListReferenceLists(context.Context, *ListReferenceListsRequest) (*ListReferenceListsResponse, error)
	// Creates a new reference list.
	CreateReferenceList(context.Context, *CreateReferenceListRequest) (*ReferenceList, error)
	// Updates an existing reference list.
	UpdateReferenceList(context.Context, *UpdateReferenceListRequest) (*ReferenceList, error)
}

ReferenceListServiceServer is the server API for ReferenceListService service.

ReferenceListSyntaxType

type ReferenceListSyntaxType int32

The syntax type indicating how list entries should be validated.

ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED, ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING, ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_REGEX, ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_CIDR

const (
	// Defaults to REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING.
	ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED ReferenceListSyntaxType = 0
	// List contains plain text patterns.
	ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING ReferenceListSyntaxType = 1
	// List contains only Regular Expression patterns.
	ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_REGEX ReferenceListSyntaxType = 2
	// List contains only CIDR patterns.
	ReferenceListSyntaxType_REFERENCE_LIST_SYNTAX_TYPE_CIDR ReferenceListSyntaxType = 3
)

func (ReferenceListSyntaxType) Descriptor

func (ReferenceListSyntaxType) Enum

func (ReferenceListSyntaxType) EnumDescriptor

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

Deprecated: Use ReferenceListSyntaxType.Descriptor instead.

func (ReferenceListSyntaxType) Number

func (ReferenceListSyntaxType) String

func (x ReferenceListSyntaxType) String() string

func (ReferenceListSyntaxType) Type

ReferenceListView

type ReferenceListView int32

ReferenceListView is a mechanism for viewing partial responses of the ReferenceList resource.

ReferenceListView_REFERENCE_LIST_VIEW_UNSPECIFIED, ReferenceListView_REFERENCE_LIST_VIEW_BASIC, ReferenceListView_REFERENCE_LIST_VIEW_FULL

const (
	// The default / unset value.
	// The API will default to the BASIC view for ListReferenceLists.
	// The API will default to the FULL view for methods that return a single
	// ReferenceList resource.
	ReferenceListView_REFERENCE_LIST_VIEW_UNSPECIFIED ReferenceListView = 0
	// Include metadata about the ReferenceList.
	// This is the default view for ListReferenceLists.
	ReferenceListView_REFERENCE_LIST_VIEW_BASIC ReferenceListView = 1
	// Include all details about the ReferenceList: metadata, content lines,
	// associated rule counts. This is the default view for GetReferenceList.
	ReferenceListView_REFERENCE_LIST_VIEW_FULL ReferenceListView = 2
)

func (ReferenceListView) Descriptor

func (ReferenceListView) Enum

func (ReferenceListView) EnumDescriptor

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

Deprecated: Use ReferenceListView.Descriptor instead.

func (ReferenceListView) Number

func (ReferenceListView) String

func (x ReferenceListView) String() string

func (ReferenceListView) Type

Retrohunt

type Retrohunt struct {

	// The resource name of the retrohunt.
	// Retrohunt is the child of a rule revision. {rule} in the format below is
	// structured as {rule_id@revision_id}.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The start and end time of the event time range this retrohunt
	// processes.
	ProcessInterval *interval.Interval `protobuf:"bytes,2,opt,name=process_interval,json=processInterval,proto3" json:"process_interval,omitempty"`
	// Output only. The start and end time of the retrohunt execution. If the
	// retrohunt is not yet finished, the end time of the interval will not be
	// populated.
	ExecutionInterval *interval.Interval `protobuf:"bytes,3,opt,name=execution_interval,json=executionInterval,proto3" json:"execution_interval,omitempty"`
	// Output only. The state of the retrohunt.
	State Retrohunt_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.chronicle.v1.Retrohunt_State" json:"state,omitempty"`
	// Output only. Percent progress of the retrohunt towards completion, from
	// 0.00 to 100.00.
	ProgressPercentage float32 `protobuf:"fixed32,5,opt,name=progress_percentage,json=progressPercentage,proto3" json:"progress_percentage,omitempty"`
	// contains filtered or unexported fields
}

Retrohunt is an execution of a Rule over a time range in the past.

func (*Retrohunt) Descriptor

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

Deprecated: Use Retrohunt.ProtoReflect.Descriptor instead.

func (*Retrohunt) GetExecutionInterval

func (x *Retrohunt) GetExecutionInterval() *interval.Interval

func (*Retrohunt) GetName

func (x *Retrohunt) GetName() string

func (*Retrohunt) GetProcessInterval

func (x *Retrohunt) GetProcessInterval() *interval.Interval

func (*Retrohunt) GetProgressPercentage

func (x *Retrohunt) GetProgressPercentage() float32

func (*Retrohunt) GetState

func (x *Retrohunt) GetState() Retrohunt_State

func (*Retrohunt) ProtoMessage

func (*Retrohunt) ProtoMessage()

func (*Retrohunt) ProtoReflect

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

func (*Retrohunt) Reset

func (x *Retrohunt) Reset()

func (*Retrohunt) String

func (x *Retrohunt) String() string

RetrohuntMetadata

type RetrohuntMetadata struct {

	// The name of the retrohunt.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}`
	Retrohunt string `protobuf:"bytes,1,opt,name=retrohunt,proto3" json:"retrohunt,omitempty"`
	// The start and end time of the retrohunt execution. If the retrohunt is not
	// yet finished, the end time of the interval will not be filled.
	ExecutionInterval *interval.Interval `protobuf:"bytes,2,opt,name=execution_interval,json=executionInterval,proto3" json:"execution_interval,omitempty"`
	// Percent progress of the retrohunt towards completion, from 0.00 to 100.00.
	ProgressPercentage float32 `protobuf:"fixed32,3,opt,name=progress_percentage,json=progressPercentage,proto3" json:"progress_percentage,omitempty"`
	// contains filtered or unexported fields
}

Operation Metadata for Retrohunts.

func (*RetrohuntMetadata) Descriptor

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

Deprecated: Use RetrohuntMetadata.ProtoReflect.Descriptor instead.

func (*RetrohuntMetadata) GetExecutionInterval

func (x *RetrohuntMetadata) GetExecutionInterval() *interval.Interval

func (*RetrohuntMetadata) GetProgressPercentage

func (x *RetrohuntMetadata) GetProgressPercentage() float32

func (*RetrohuntMetadata) GetRetrohunt

func (x *RetrohuntMetadata) GetRetrohunt() string

func (*RetrohuntMetadata) ProtoMessage

func (*RetrohuntMetadata) ProtoMessage()

func (*RetrohuntMetadata) ProtoReflect

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

func (*RetrohuntMetadata) Reset

func (x *RetrohuntMetadata) Reset()

func (*RetrohuntMetadata) String

func (x *RetrohuntMetadata) String() string

Retrohunt_State

type Retrohunt_State int32

The possible states a retrohunt can be in.

Retrohunt_STATE_UNSPECIFIED, Retrohunt_RUNNING, Retrohunt_DONE, Retrohunt_CANCELLED, Retrohunt_FAILED

const (
	// Unspecified or unknown retrohunt state.
	Retrohunt_STATE_UNSPECIFIED Retrohunt_State = 0
	// Running state.
	Retrohunt_RUNNING Retrohunt_State = 1
	// Done state.
	Retrohunt_DONE Retrohunt_State = 2
	// Cancelled state.
	Retrohunt_CANCELLED Retrohunt_State = 3
	// Failed state.
	Retrohunt_FAILED Retrohunt_State = 4
)

func (Retrohunt_State) Descriptor

func (Retrohunt_State) Enum

func (x Retrohunt_State) Enum() *Retrohunt_State

func (Retrohunt_State) EnumDescriptor

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

Deprecated: Use Retrohunt_State.Descriptor instead.

func (Retrohunt_State) Number

func (Retrohunt_State) String

func (x Retrohunt_State) String() string

func (Retrohunt_State) Type

Rule

type Rule struct {

	// Identifier. Full resource name for the rule.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The revision ID of the rule.
	// A new revision is created whenever the rule text is changed in any way.
	// Format: `v_{10 digits}_{9 digits}`
	// Populated in REVISION_METADATA_ONLY view and FULL view.
	RevisionId string `protobuf:"bytes,2,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`
	// Output only. Display name of the rule.
	// Populated in BASIC view and FULL view.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The YARA-L content of the rule.
	// Populated in FULL view.
	Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"`
	// Output only. The author of the rule. Extracted from the meta section of
	// text. Populated in BASIC view and FULL view.
	Author string `protobuf:"bytes,5,opt,name=author,proto3" json:"author,omitempty"`
	// Output only. The severity of the rule as specified in the meta section of
	// text. Populated in BASIC view and FULL view.
	Severity *Severity `protobuf:"bytes,6,opt,name=severity,proto3" json:"severity,omitempty"`
	// Output only. Additional metadata specified in the meta section of text.
	// Populated in FULL view.
	Metadata map[string]string `protobuf:"bytes,7,rep,name=metadata,proto3" json:"metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
	// Output only. The timestamp of when the rule was created.
	// Populated in FULL view.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp of when the rule revision was created.
	// Populated in FULL, REVISION_METADATA_ONLY views.
	RevisionCreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=revision_create_time,json=revisionCreateTime,proto3" json:"revision_create_time,omitempty"`
	// Output only. The current compilation state of the rule.
	// Populated in FULL view.
	CompilationState Rule_CompilationState `protobuf:"varint,10,opt,name=compilation_state,json=compilationState,proto3,enum=google.cloud.chronicle.v1.Rule_CompilationState" json:"compilation_state,omitempty"`
	// Output only. User-facing type of the rule. Extracted from the events
	// section of rule text. Populated in BASIC view and FULL view.
	Type RuleType `protobuf:"varint,12,opt,name=type,proto3,enum=google.cloud.chronicle.v1.RuleType" json:"type,omitempty"`
	// Output only. Resource names of the reference lists used in this rule.
	// Populated in FULL view.
	ReferenceLists []string `protobuf:"bytes,13,rep,name=reference_lists,json=referenceLists,proto3" json:"reference_lists,omitempty"`
	// Output only. The run frequencies that are allowed for the rule.
	// Populated in BASIC view and FULL view.
	AllowedRunFrequencies []RunFrequency `protobuf:"varint,14,rep,packed,name=allowed_run_frequencies,json=allowedRunFrequencies,proto3,enum=google.cloud.chronicle.v1.RunFrequency" json:"allowed_run_frequencies,omitempty"`
	// The etag for this rule.
	// If this is provided on update, the request will succeed if and only if it
	// matches the server-computed value, and will fail with an ABORTED error
	// otherwise.
	// Populated in BASIC view and FULL view.
	Etag string `protobuf:"bytes,15,opt,name=etag,proto3" json:"etag,omitempty"`
	// Resource name of the DataAccessScope bound to this rule.
	// Populated in BASIC view and FULL view.
	// If reference lists are used in the rule, validations will be performed
	// against this scope to ensure that the reference lists are compatible with
	// both the user's and the rule's scopes.
	// The scope should be in the format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope}`.
	Scope string `protobuf:"bytes,16,opt,name=scope,proto3" json:"scope,omitempty"`
	// Output only. A list of a rule's corresponding compilation diagnostic
	// messages such as compilation errors and compilation warnings. Populated in
	// FULL view.
	CompilationDiagnostics []*CompilationDiagnostic `protobuf:"bytes,17,rep,name=compilation_diagnostics,json=compilationDiagnostics,proto3" json:"compilation_diagnostics,omitempty"`
	// Output only. Indicate the rule can run in near real time live rule.
	// If this is true, the rule uses the near real time live rule when the run
	// frequency is set to LIVE.
	NearRealTimeLiveRuleEligible bool `protobuf:"varint,18,opt,name=near_real_time_live_rule_eligible,json=nearRealTimeLiveRuleEligible,proto3" json:"near_real_time_live_rule_eligible,omitempty"`
	// Output only. The set of inputs used in the rule. For example, if the rule
	// uses $e.principal.hostname, then the uses_udm field will be true.
	InputsUsed *InputsUsed `protobuf:"bytes,20,opt,name=inputs_used,json=inputsUsed,proto3" json:"inputs_used,omitempty"`
	// contains filtered or unexported fields
}

The Rule resource represents a user-created rule. NEXT TAG: 21

func (*Rule) Descriptor

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

Deprecated: Use Rule.ProtoReflect.Descriptor instead.

func (*Rule) GetAllowedRunFrequencies

func (x *Rule) GetAllowedRunFrequencies() []RunFrequency

func (*Rule) GetAuthor

func (x *Rule) GetAuthor() string

func (*Rule) GetCompilationDiagnostics

func (x *Rule) GetCompilationDiagnostics() []*CompilationDiagnostic

func (*Rule) GetCompilationState

func (x *Rule) GetCompilationState() Rule_CompilationState

func (*Rule) GetCreateTime

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

func (*Rule) GetDisplayName

func (x *Rule) GetDisplayName() string

func (*Rule) GetEtag

func (x *Rule) GetEtag() string

func (*Rule) GetInputsUsed

func (x *Rule) GetInputsUsed() *InputsUsed

func (*Rule) GetMetadata

func (x *Rule) GetMetadata() map[string]string

func (*Rule) GetName

func (x *Rule) GetName() string

func (*Rule) GetNearRealTimeLiveRuleEligible

func (x *Rule) GetNearRealTimeLiveRuleEligible() bool

func (*Rule) GetReferenceLists

func (x *Rule) GetReferenceLists() []string

func (*Rule) GetRevisionCreateTime

func (x *Rule) GetRevisionCreateTime() *timestamppb.Timestamp

func (*Rule) GetRevisionId

func (x *Rule) GetRevisionId() string

func (*Rule) GetScope

func (x *Rule) GetScope() string

func (*Rule) GetSeverity

func (x *Rule) GetSeverity() *Severity

func (*Rule) GetText

func (x *Rule) GetText() string

func (*Rule) GetType

func (x *Rule) GetType() RuleType

func (*Rule) ProtoMessage

func (*Rule) ProtoMessage()

func (*Rule) ProtoReflect

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

func (*Rule) Reset

func (x *Rule) Reset()

func (*Rule) String

func (x *Rule) String() string

RuleDeployment

type RuleDeployment struct {

	// Required. The resource name of the rule deployment.
	// Note that RuleDeployment is a child of the overall Rule, not any individual
	// revision, so the resource ID segment for the Rule resource must not
	// reference a specific revision.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Whether the rule is currently deployed continuously against incoming data.
	Enabled bool `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Whether detections resulting from this deployment should be considered
	// alerts.
	Alerting bool `protobuf:"varint,3,opt,name=alerting,proto3" json:"alerting,omitempty"`
	// The archive state of the rule deployment.
	// Cannot be set to true unless enabled is set to false.
	// If set to true, alerting will automatically be set to false.
	// If currently set to true, enabled, alerting, and run_frequency cannot be
	// updated.
	Archived bool `protobuf:"varint,4,opt,name=archived,proto3" json:"archived,omitempty"`
	// Output only. The timestamp when the rule deployment archive state was last
	// set to true. If the rule deployment's current archive state is not set to
	// true, the field will be empty.
	ArchiveTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=archive_time,json=archiveTime,proto3" json:"archive_time,omitempty"`
	// The run frequency of the rule deployment.
	RunFrequency RunFrequency `protobuf:"varint,6,opt,name=run_frequency,json=runFrequency,proto3,enum=google.cloud.chronicle.v1.RunFrequency" json:"run_frequency,omitempty"`
	// Output only. The execution state of the rule deployment.
	ExecutionState RuleDeployment_ExecutionState `protobuf:"varint,7,opt,name=execution_state,json=executionState,proto3,enum=google.cloud.chronicle.v1.RuleDeployment_ExecutionState" json:"execution_state,omitempty"`
	// Output only. The names of the associated/chained producer rules. Rules are
	// considered producers for this rule if this rule explicitly filters on their
	// ruleid. Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	ProducerRules []string `protobuf:"bytes,8,rep,name=producer_rules,json=producerRules,proto3" json:"producer_rules,omitempty"`
	// Output only. The names of the associated/chained consumer rules. Rules are
	// considered consumers of this rule if their rule text explicitly filters on
	// this rule's ruleid. Format:
	// `projects/{project}/locations/{location}/instances/{instance}/rules/{rule}`
	ConsumerRules []string `protobuf:"bytes,9,rep,name=consumer_rules,json=consumerRules,proto3" json:"consumer_rules,omitempty"`
	// Output only. The timestamp when the rule deployment alert state was lastly
	// changed. This is filled regardless of the current alert state. E.g. if the
	// current alert status is false, this timestamp will be the timestamp when
	// the alert status was changed to false.
	LastAlertStatusChangeTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=last_alert_status_change_time,json=lastAlertStatusChangeTime,proto3" json:"last_alert_status_change_time,omitempty"`
	// contains filtered or unexported fields
}

The RuleDeployment resource represents the deployment state of a Rule.

func (*RuleDeployment) Descriptor

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

Deprecated: Use RuleDeployment.ProtoReflect.Descriptor instead.

func (*RuleDeployment) GetAlerting

func (x *RuleDeployment) GetAlerting() bool

func (*RuleDeployment) GetArchiveTime

func (x *RuleDeployment) GetArchiveTime() *timestamppb.Timestamp

func (*RuleDeployment) GetArchived

func (x *RuleDeployment) GetArchived() bool

func (*RuleDeployment) GetConsumerRules

func (x *RuleDeployment) GetConsumerRules() []string

func (*RuleDeployment) GetEnabled

func (x *RuleDeployment) GetEnabled() bool

func (*RuleDeployment) GetExecutionState

func (x *RuleDeployment) GetExecutionState() RuleDeployment_ExecutionState

func (*RuleDeployment) GetLastAlertStatusChangeTime

func (x *RuleDeployment) GetLastAlertStatusChangeTime() *timestamppb.Timestamp

func (*RuleDeployment) GetName

func (x *RuleDeployment) GetName() string

func (*RuleDeployment) GetProducerRules

func (x *RuleDeployment) GetProducerRules() []string

func (*RuleDeployment) GetRunFrequency

func (x *RuleDeployment) GetRunFrequency() RunFrequency

func (*RuleDeployment) ProtoMessage

func (*RuleDeployment) ProtoMessage()

func (*RuleDeployment) ProtoReflect

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

func (*RuleDeployment) Reset

func (x *RuleDeployment) Reset()

func (*RuleDeployment) String

func (x *RuleDeployment) String() string

RuleDeployment_ExecutionState

type RuleDeployment_ExecutionState int32

The possible execution states the rule deployment can be in.

RuleDeployment_EXECUTION_STATE_UNSPECIFIED, RuleDeployment_DEFAULT, RuleDeployment_LIMITED, RuleDeployment_PAUSED

const (
	// Unspecified or unknown execution state.
	RuleDeployment_EXECUTION_STATE_UNSPECIFIED RuleDeployment_ExecutionState = 0
	// Default execution state.
	RuleDeployment_DEFAULT RuleDeployment_ExecutionState = 1
	// Rules in limited state may not have their executions guaranteed.
	RuleDeployment_LIMITED RuleDeployment_ExecutionState = 2
	// Paused rules are not executed at all.
	RuleDeployment_PAUSED RuleDeployment_ExecutionState = 3
)

func (RuleDeployment_ExecutionState) Descriptor

func (RuleDeployment_ExecutionState) Enum

func (RuleDeployment_ExecutionState) EnumDescriptor

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

Deprecated: Use RuleDeployment_ExecutionState.Descriptor instead.

func (RuleDeployment_ExecutionState) Number

func (RuleDeployment_ExecutionState) String

func (RuleDeployment_ExecutionState) Type

RuleServiceClient

type RuleServiceClient interface {
	// Creates a new Rule.
	CreateRule(ctx context.Context, in *CreateRuleRequest, opts ...grpc.CallOption) (*Rule, error)
	// Gets a Rule.
	GetRule(ctx context.Context, in *GetRuleRequest, opts ...grpc.CallOption) (*Rule, error)
	// Lists Rules.
	ListRules(ctx context.Context, in *ListRulesRequest, opts ...grpc.CallOption) (*ListRulesResponse, error)
	// Updates a Rule.
	UpdateRule(ctx context.Context, in *UpdateRuleRequest, opts ...grpc.CallOption) (*Rule, error)
	// Deletes a Rule.
	DeleteRule(ctx context.Context, in *DeleteRuleRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all revisions of the rule.
	ListRuleRevisions(ctx context.Context, in *ListRuleRevisionsRequest, opts ...grpc.CallOption) (*ListRuleRevisionsResponse, error)
	// Create a Retrohunt.
	CreateRetrohunt(ctx context.Context, in *CreateRetrohuntRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Get a Retrohunt.
	GetRetrohunt(ctx context.Context, in *GetRetrohuntRequest, opts ...grpc.CallOption) (*Retrohunt, error)
	// List Retrohunts.
	ListRetrohunts(ctx context.Context, in *ListRetrohuntsRequest, opts ...grpc.CallOption) (*ListRetrohuntsResponse, error)
	// Gets a RuleDeployment.
	GetRuleDeployment(ctx context.Context, in *GetRuleDeploymentRequest, opts ...grpc.CallOption) (*RuleDeployment, error)
	// Lists RuleDeployments across all Rules.
	ListRuleDeployments(ctx context.Context, in *ListRuleDeploymentsRequest, opts ...grpc.CallOption) (*ListRuleDeploymentsResponse, error)
	// Updates a RuleDeployment.
	// Failures are not necessarily atomic. If there is a request to update
	// multiple fields, and any update to a single field fails, an error will be
	// returned, but other fields may remain successfully updated.
	UpdateRuleDeployment(ctx context.Context, in *UpdateRuleDeploymentRequest, opts ...grpc.CallOption) (*RuleDeployment, error)
}

RuleServiceClient is the client API for RuleService service.

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

func NewRuleServiceClient

func NewRuleServiceClient(cc grpc.ClientConnInterface) RuleServiceClient

RuleServiceServer

type RuleServiceServer interface {
	// Creates a new Rule.
	CreateRule(context.Context, *CreateRuleRequest) (*Rule, error)
	// Gets a Rule.
	GetRule(context.Context, *GetRuleRequest) (*Rule, error)
	// Lists Rules.
	ListRules(context.Context, *ListRulesRequest) (*ListRulesResponse, error)
	// Updates a Rule.
	UpdateRule(context.Context, *UpdateRuleRequest) (*Rule, error)
	// Deletes a Rule.
	DeleteRule(context.Context, *DeleteRuleRequest) (*emptypb.Empty, error)
	// Lists all revisions of the rule.
	ListRuleRevisions(context.Context, *ListRuleRevisionsRequest) (*ListRuleRevisionsResponse, error)
	// Create a Retrohunt.
	CreateRetrohunt(context.Context, *CreateRetrohuntRequest) (*longrunningpb.Operation, error)
	// Get a Retrohunt.
	GetRetrohunt(context.Context, *GetRetrohuntRequest) (*Retrohunt, error)
	// List Retrohunts.
	ListRetrohunts(context.Context, *ListRetrohuntsRequest) (*ListRetrohuntsResponse, error)
	// Gets a RuleDeployment.
	GetRuleDeployment(context.Context, *GetRuleDeploymentRequest) (*RuleDeployment, error)
	// Lists RuleDeployments across all Rules.
	ListRuleDeployments(context.Context, *ListRuleDeploymentsRequest) (*ListRuleDeploymentsResponse, error)
	// Updates a RuleDeployment.
	// Failures are not necessarily atomic. If there is a request to update
	// multiple fields, and any update to a single field fails, an error will be
	// returned, but other fields may remain successfully updated.
	UpdateRuleDeployment(context.Context, *UpdateRuleDeploymentRequest) (*RuleDeployment, error)
}

RuleServiceServer is the server API for RuleService service.

RuleType

type RuleType int32

RuleType indicates the YARA-L rule type of user-created and Google Cloud Threat Intelligence (GCTI) authored rules.

RuleType_RULE_TYPE_UNSPECIFIED, RuleType_SINGLE_EVENT, RuleType_MULTI_EVENT

const (
	// The rule type is unspecified/unknown.
	RuleType_RULE_TYPE_UNSPECIFIED RuleType = 0
	// Rule checks for the existence of a single event.
	RuleType_SINGLE_EVENT RuleType = 1
	// Rule checks for correlation between multiple events
	RuleType_MULTI_EVENT RuleType = 2
)

func (RuleType) Descriptor

func (RuleType) Descriptor() protoreflect.EnumDescriptor

func (RuleType) Enum

func (x RuleType) Enum() *RuleType

func (RuleType) EnumDescriptor

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

Deprecated: Use RuleType.Descriptor instead.

func (RuleType) Number

func (x RuleType) Number() protoreflect.EnumNumber

func (RuleType) String

func (x RuleType) String() string

func (RuleType) Type

RuleView

type RuleView int32

RuleView indicates the scope of fields to populate when returning the Rule resource.

RuleView_RULE_VIEW_UNSPECIFIED, RuleView_BASIC, RuleView_FULL, RuleView_REVISION_METADATA_ONLY

const (
	// The default/unset value.
	// The API will default to the BASIC view for ListRules/ListRuleRevisions.
	// The API will default to the FULL view for GetRule.
	RuleView_RULE_VIEW_UNSPECIFIED RuleView = 0
	// Include basic metadata about the rule, but not the full contents.
	// Returned fields include: revision_id, revision_create_time, display_name,
	// author, severity, type, allowed_run_frequency,
	// near_real_time_live_rule_eligible, etag, and scope.
	// This is the default value for ListRules and ListRuleRevisions.
	RuleView_BASIC RuleView = 1
	// Include all fields.
	// This is the default value for GetRule.
	RuleView_FULL RuleView = 2
	// Include basic metadata about the rule's revision only.
	// Returned fields include: revision_id and revision_create_time.
	RuleView_REVISION_METADATA_ONLY RuleView = 3
)

func (RuleView) Descriptor

func (RuleView) Descriptor() protoreflect.EnumDescriptor

func (RuleView) Enum

func (x RuleView) Enum() *RuleView

func (RuleView) EnumDescriptor

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

Deprecated: Use RuleView.Descriptor instead.

func (RuleView) Number

func (x RuleView) Number() protoreflect.EnumNumber

func (RuleView) String

func (x RuleView) String() string

func (RuleView) Type

Rule_CompilationState

type Rule_CompilationState int32

The current compilation state of the rule.

Rule_COMPILATION_STATE_UNSPECIFIED, Rule_SUCCEEDED, Rule_FAILED

const (
	// The compilation state is unspecified/unknown.
	Rule_COMPILATION_STATE_UNSPECIFIED Rule_CompilationState = 0
	// The Rule can successfully compile.
	Rule_SUCCEEDED Rule_CompilationState = 1
	// The Rule cannot successfully compile.
	// This is possible if a backwards-incompatible change was made to the
	// compiler.
	Rule_FAILED Rule_CompilationState = 2
)

func (Rule_CompilationState) Descriptor

func (Rule_CompilationState) Enum

func (Rule_CompilationState) EnumDescriptor

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

Deprecated: Use Rule_CompilationState.Descriptor instead.

func (Rule_CompilationState) Number

func (Rule_CompilationState) String

func (x Rule_CompilationState) String() string

func (Rule_CompilationState) Type

RunFrequency

type RunFrequency int32

RunFrequency indicates the run frequency at which a YARA-L 2 rule will run if enabled.

RunFrequency_RUN_FREQUENCY_UNSPECIFIED, RunFrequency_LIVE, RunFrequency_HOURLY, RunFrequency_DAILY

const (
	// The run frequency is unspecified/unknown.
	RunFrequency_RUN_FREQUENCY_UNSPECIFIED RunFrequency = 0
	// Executes in real time.
	RunFrequency_LIVE RunFrequency = 1
	// Executes once per hour.
	RunFrequency_HOURLY RunFrequency = 2
	// Executes once per day.
	RunFrequency_DAILY RunFrequency = 3
)

func (RunFrequency) Descriptor

func (RunFrequency) Enum

func (x RunFrequency) Enum() *RunFrequency

func (RunFrequency) EnumDescriptor

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

Deprecated: Use RunFrequency.Descriptor instead.

func (RunFrequency) Number

func (RunFrequency) String

func (x RunFrequency) String() string

func (RunFrequency) Type

ScopeInfo

type ScopeInfo struct {

	// Required. The list of scope names of the reference list, if the list is
	// empty the reference list is treated as unscoped.
	ReferenceListScope *ReferenceListScope `protobuf:"bytes,2,opt,name=reference_list_scope,json=referenceListScope,proto3" json:"reference_list_scope,omitempty"`
	// contains filtered or unexported fields
}

ScopeInfo specifies the scope info of the reference list.

func (*ScopeInfo) Descriptor

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

Deprecated: Use ScopeInfo.ProtoReflect.Descriptor instead.

func (*ScopeInfo) GetReferenceListScope

func (x *ScopeInfo) GetReferenceListScope() *ReferenceListScope

func (*ScopeInfo) ProtoMessage

func (*ScopeInfo) ProtoMessage()

func (*ScopeInfo) ProtoReflect

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

func (*ScopeInfo) Reset

func (x *ScopeInfo) Reset()

func (*ScopeInfo) String

func (x *ScopeInfo) String() string

Severity

type Severity struct {

	// The display name of the severity level. Extracted from the meta section of
	// the rule text.
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

Severity represents the severity level of the rule.

func (*Severity) Descriptor

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

Deprecated: Use Severity.ProtoReflect.Descriptor instead.

func (*Severity) GetDisplayName

func (x *Severity) GetDisplayName() string

func (*Severity) ProtoMessage

func (*Severity) ProtoMessage()

func (*Severity) ProtoReflect

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

func (*Severity) Reset

func (x *Severity) Reset()

func (*Severity) String

func (x *Severity) String() string

UnimplementedDataAccessControlServiceServer

type UnimplementedDataAccessControlServiceServer struct {
}

UnimplementedDataAccessControlServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataAccessControlServiceServer) CreateDataAccessLabel

func (*UnimplementedDataAccessControlServiceServer) CreateDataAccessScope

func (*UnimplementedDataAccessControlServiceServer) DeleteDataAccessLabel

func (*UnimplementedDataAccessControlServiceServer) DeleteDataAccessScope

func (*UnimplementedDataAccessControlServiceServer) GetDataAccessLabel

func (*UnimplementedDataAccessControlServiceServer) GetDataAccessScope

func (*UnimplementedDataAccessControlServiceServer) ListDataAccessLabels

func (*UnimplementedDataAccessControlServiceServer) ListDataAccessScopes

func (*UnimplementedDataAccessControlServiceServer) UpdateDataAccessLabel

func (*UnimplementedDataAccessControlServiceServer) UpdateDataAccessScope

UnimplementedEntityServiceServer

type UnimplementedEntityServiceServer struct {
}

UnimplementedEntityServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEntityServiceServer) CreateWatchlist

func (*UnimplementedEntityServiceServer) DeleteWatchlist

func (*UnimplementedEntityServiceServer) GetWatchlist

func (*UnimplementedEntityServiceServer) ListWatchlists

func (*UnimplementedEntityServiceServer) UpdateWatchlist

UnimplementedInstanceServiceServer

type UnimplementedInstanceServiceServer struct {
}

UnimplementedInstanceServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedInstanceServiceServer) GetInstance

UnimplementedReferenceListServiceServer

type UnimplementedReferenceListServiceServer struct {
}

UnimplementedReferenceListServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedReferenceListServiceServer) CreateReferenceList

func (*UnimplementedReferenceListServiceServer) GetReferenceList

func (*UnimplementedReferenceListServiceServer) ListReferenceLists

func (*UnimplementedReferenceListServiceServer) UpdateReferenceList

UnimplementedRuleServiceServer

type UnimplementedRuleServiceServer struct {
}

UnimplementedRuleServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRuleServiceServer) CreateRetrohunt

func (*UnimplementedRuleServiceServer) CreateRule

func (*UnimplementedRuleServiceServer) DeleteRule

func (*UnimplementedRuleServiceServer) GetRetrohunt

func (*UnimplementedRuleServiceServer) GetRule

func (*UnimplementedRuleServiceServer) GetRuleDeployment

func (*UnimplementedRuleServiceServer) ListRetrohunts

func (*UnimplementedRuleServiceServer) ListRuleDeployments

func (*UnimplementedRuleServiceServer) ListRuleRevisions

func (*UnimplementedRuleServiceServer) ListRules

func (*UnimplementedRuleServiceServer) UpdateRule

func (*UnimplementedRuleServiceServer) UpdateRuleDeployment

UpdateDataAccessLabelRequest

type UpdateDataAccessLabelRequest struct {

	// Required. The data access label to update.
	//
	// The label's `name` field is used to identify the label to update.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
	DataAccessLabel *DataAccessLabel `protobuf:"bytes,1,opt,name=data_access_label,json=dataAccessLabel,proto3" json:"data_access_label,omitempty"`
	// The list of fields to update. If not included, all fields with a non-empty
	// value will be overwritten. Currently, only the description and definition
	// fields are supported for update; an update call that attempts to update any
	// other fields will return INVALID_ARGUMENT.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for UpdateDataAccessLabel method.

func (*UpdateDataAccessLabelRequest) Descriptor

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

Deprecated: Use UpdateDataAccessLabelRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataAccessLabelRequest) GetDataAccessLabel

func (x *UpdateDataAccessLabelRequest) GetDataAccessLabel() *DataAccessLabel

func (*UpdateDataAccessLabelRequest) GetUpdateMask

func (*UpdateDataAccessLabelRequest) ProtoMessage

func (*UpdateDataAccessLabelRequest) ProtoMessage()

func (*UpdateDataAccessLabelRequest) ProtoReflect

func (*UpdateDataAccessLabelRequest) Reset

func (x *UpdateDataAccessLabelRequest) Reset()

func (*UpdateDataAccessLabelRequest) String

UpdateDataAccessScopeRequest

type UpdateDataAccessScopeRequest struct {

	// Required. The data access scope to update.
	//
	// The scope's `name` field is used to identify the scope to update.
	// Format:
	// `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
	DataAccessScope *DataAccessScope `protobuf:"bytes,1,opt,name=data_access_scope,json=dataAccessScope,proto3" json:"data_access_scope,omitempty"`
	// The list of fields to update. If not included, all fields with a non-empty
	// value will be overwritten. Currently, only the description, the allowed
	// and denied labels list fields are supported for update;
	// an update call that attempts to update any
	// other fields will return INVALID_ARGUMENT.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request message for UpdateDataAccessScope method.

func (*UpdateDataAccessScopeRequest) Descriptor

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

Deprecated: Use UpdateDataAccessScopeRequest.ProtoReflect.Descriptor instead.

func (*UpdateDataAccessScopeRequest) GetDataAccessScope

func (x *UpdateDataAccessScopeRequest) GetDataAccessScope() *DataAccessScope

func (*UpdateDataAccessScopeRequest) GetUpdateMask

func (*UpdateDataAccessScopeRequest) ProtoMessage

func (*UpdateDataAccessScopeRequest) ProtoMessage()

func (*UpdateDataAccessScopeRequest) ProtoReflect

func (*UpdateDataAccessScopeRequest) Reset

func (x *UpdateDataAccessScopeRequest) Reset()

func (*UpdateDataAccessScopeRequest) String

UpdateReferenceListRequest

type UpdateReferenceListRequest struct {

	// Required. The reference list to update.
	//
	// The reference list's `name` field is used to identify the reference list to
	// update.
	// Format:
	// `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}`
	ReferenceList *