[go: up one dir, main page]

idspb

package
v1.5.7 Latest Latest
Warning

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

Go to latest
Published: Sep 18, 2025 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Index

Constants

View Source
const (
	IDS_ListEndpoints_FullMethodName  = "/google.cloud.ids.v1.IDS/ListEndpoints"
	IDS_GetEndpoint_FullMethodName    = "/google.cloud.ids.v1.IDS/GetEndpoint"
	IDS_CreateEndpoint_FullMethodName = "/google.cloud.ids.v1.IDS/CreateEndpoint"
	IDS_DeleteEndpoint_FullMethodName = "/google.cloud.ids.v1.IDS/DeleteEndpoint"
)

Variables

View Source
var (
	Endpoint_Severity_name = map[int32]string{
		0: "SEVERITY_UNSPECIFIED",
		1: "INFORMATIONAL",
		2: "LOW",
		3: "MEDIUM",
		4: "HIGH",
		5: "CRITICAL",
	}
	Endpoint_Severity_value = map[string]int32{
		"SEVERITY_UNSPECIFIED": 0,
		"INFORMATIONAL":        1,
		"LOW":                  2,
		"MEDIUM":               3,
		"HIGH":                 4,
		"CRITICAL":             5,
	}
)

Enum value maps for Endpoint_Severity.

View Source
var (
	Endpoint_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
		3: "DELETING",
	}
	Endpoint_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
		"DELETING":          3,
	}
)

Enum value maps for Endpoint_State.

View Source
var File_google_cloud_ids_v1_ids_proto protoreflect.FileDescriptor
View Source
var IDS_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.ids.v1.IDS",
	HandlerType: (*IDSServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListEndpoints",
			Handler:    _IDS_ListEndpoints_Handler,
		},
		{
			MethodName: "GetEndpoint",
			Handler:    _IDS_GetEndpoint_Handler,
		},
		{
			MethodName: "CreateEndpoint",
			Handler:    _IDS_CreateEndpoint_Handler,
		},
		{
			MethodName: "DeleteEndpoint",
			Handler:    _IDS_DeleteEndpoint_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/ids/v1/ids.proto",
}

IDS_ServiceDesc is the grpc.ServiceDesc for IDS service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterIDSServer

func RegisterIDSServer(s grpc.ServiceRegistrar, srv IDSServer)

Types

type CreateEndpointRequest

type CreateEndpointRequest struct {

	// Required. The endpoint's parent.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The endpoint identifier. This will be part of the endpoint's
	// resource name.
	// This value must start with a lowercase letter followed by up to 62
	// lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
	// Values that do not match this pattern will trigger an INVALID_ARGUMENT
	// error.
	EndpointId string `protobuf:"bytes,2,opt,name=endpoint_id,json=endpointId,proto3" json:"endpoint_id,omitempty"`
	// Required. The endpoint to create.
	Endpoint *Endpoint `protobuf:"bytes,3,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// An optional request ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore
	// the request if it has already been completed. The server will guarantee
	// that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and t
	// he request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateEndpointRequest) Descriptor deprecated

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

Deprecated: Use CreateEndpointRequest.ProtoReflect.Descriptor instead.

func (*CreateEndpointRequest) GetEndpoint

func (x *CreateEndpointRequest) GetEndpoint() *Endpoint

func (*CreateEndpointRequest) GetEndpointId

func (x *CreateEndpointRequest) GetEndpointId() string

func (*CreateEndpointRequest) GetParent

func (x *CreateEndpointRequest) GetParent() string

func (*CreateEndpointRequest) GetRequestId

func (x *CreateEndpointRequest) GetRequestId() string

func (*CreateEndpointRequest) ProtoMessage

func (*CreateEndpointRequest) ProtoMessage()

func (*CreateEndpointRequest) ProtoReflect

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

func (*CreateEndpointRequest) Reset

func (x *CreateEndpointRequest) Reset()

func (*CreateEndpointRequest) String

func (x *CreateEndpointRequest) String() string

type DeleteEndpointRequest

type DeleteEndpointRequest struct {

	// Required. The name of the endpoint to delete.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An optional request ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore
	// the request if it has already been completed. The server will guarantee
	// that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and t
	// he request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteEndpointRequest) Descriptor deprecated

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

Deprecated: Use DeleteEndpointRequest.ProtoReflect.Descriptor instead.

func (*DeleteEndpointRequest) GetName

func (x *DeleteEndpointRequest) GetName() string

func (*DeleteEndpointRequest) GetRequestId

func (x *DeleteEndpointRequest) GetRequestId() string

func (*DeleteEndpointRequest) ProtoMessage

func (*DeleteEndpointRequest) ProtoMessage()

func (*DeleteEndpointRequest) ProtoReflect

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

func (*DeleteEndpointRequest) Reset

func (x *DeleteEndpointRequest) Reset()

func (*DeleteEndpointRequest) String

func (x *DeleteEndpointRequest) String() string

type Endpoint

type Endpoint struct {

	// Output only. The name of the endpoint.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The create time timestamp.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The update time timestamp.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The labels of the endpoint.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Required. The fully qualified URL of the network to which the IDS Endpoint is
	// attached.
	Network string `protobuf:"bytes,5,opt,name=network,proto3" json:"network,omitempty"`
	// Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.
	EndpointForwardingRule string `` /* 129-byte string literal not displayed */
	// Output only. The IP address of the IDS Endpoint's ILB.
	EndpointIp string `protobuf:"bytes,7,opt,name=endpoint_ip,json=endpointIp,proto3" json:"endpoint_ip,omitempty"`
	// User-provided description of the endpoint
	Description string `protobuf:"bytes,8,opt,name=description,proto3" json:"description,omitempty"`
	// Required. Lowest threat severity that this endpoint will alert on.
	Severity Endpoint_Severity `protobuf:"varint,9,opt,name=severity,proto3,enum=google.cloud.ids.v1.Endpoint_Severity" json:"severity,omitempty"`
	// Output only. Current state of the endpoint.
	State Endpoint_State `protobuf:"varint,12,opt,name=state,proto3,enum=google.cloud.ids.v1.Endpoint_State" json:"state,omitempty"`
	// Whether the endpoint should report traffic logs in addition to threat logs.
	TrafficLogs bool `protobuf:"varint,13,opt,name=traffic_logs,json=trafficLogs,proto3" json:"traffic_logs,omitempty"`
	// contains filtered or unexported fields
}

Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.

func (*Endpoint) Descriptor deprecated

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

Deprecated: Use Endpoint.ProtoReflect.Descriptor instead.

func (*Endpoint) GetCreateTime

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

func (*Endpoint) GetDescription

func (x *Endpoint) GetDescription() string

func (*Endpoint) GetEndpointForwardingRule

func (x *Endpoint) GetEndpointForwardingRule() string

func (*Endpoint) GetEndpointIp

func (x *Endpoint) GetEndpointIp() string

func (*Endpoint) GetLabels

func (x *Endpoint) GetLabels() map[string]string

func (*Endpoint) GetName

func (x *Endpoint) GetName() string

func (*Endpoint) GetNetwork

func (x *Endpoint) GetNetwork() string

func (*Endpoint) GetSeverity

func (x *Endpoint) GetSeverity() Endpoint_Severity

func (*Endpoint) GetState

func (x *Endpoint) GetState() Endpoint_State

func (*Endpoint) GetTrafficLogs

func (x *Endpoint) GetTrafficLogs() bool

func (*Endpoint) GetUpdateTime

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

func (*Endpoint) ProtoMessage

func (*Endpoint) ProtoMessage()

func (*Endpoint) ProtoReflect

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

func (*Endpoint) Reset

func (x *Endpoint) Reset()

func (*Endpoint) String

func (x *Endpoint) String() string

type Endpoint_Severity

type Endpoint_Severity int32

Threat severity levels.

const (
	// Not set.
	Endpoint_SEVERITY_UNSPECIFIED Endpoint_Severity = 0
	// Informational alerts.
	Endpoint_INFORMATIONAL Endpoint_Severity = 1
	// Low severity alerts.
	Endpoint_LOW Endpoint_Severity = 2
	// Medium severity alerts.
	Endpoint_MEDIUM Endpoint_Severity = 3
	// High severity alerts.
	Endpoint_HIGH Endpoint_Severity = 4
	// Critical severity alerts.
	Endpoint_CRITICAL Endpoint_Severity = 5
)

func (Endpoint_Severity) Descriptor

func (Endpoint_Severity) Enum

func (Endpoint_Severity) EnumDescriptor deprecated

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

Deprecated: Use Endpoint_Severity.Descriptor instead.

func (Endpoint_Severity) Number

func (Endpoint_Severity) String

func (x Endpoint_Severity) String() string

func (Endpoint_Severity) Type

type Endpoint_State

type Endpoint_State int32

Endpoint state

const (
	// Not set.
	Endpoint_STATE_UNSPECIFIED Endpoint_State = 0
	// Being created.
	Endpoint_CREATING Endpoint_State = 1
	// Active and ready for traffic.
	Endpoint_READY Endpoint_State = 2
	// Being deleted.
	Endpoint_DELETING Endpoint_State = 3
)

func (Endpoint_State) Descriptor

func (Endpoint_State) Enum

func (x Endpoint_State) Enum() *Endpoint_State

func (Endpoint_State) EnumDescriptor deprecated

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

Deprecated: Use Endpoint_State.Descriptor instead.

func (Endpoint_State) Number

func (Endpoint_State) String

func (x Endpoint_State) String() string

func (Endpoint_State) Type

type GetEndpointRequest

type GetEndpointRequest struct {

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

func (*GetEndpointRequest) Descriptor deprecated

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

Deprecated: Use GetEndpointRequest.ProtoReflect.Descriptor instead.

func (*GetEndpointRequest) GetName

func (x *GetEndpointRequest) GetName() string

func (*GetEndpointRequest) ProtoMessage

func (*GetEndpointRequest) ProtoMessage()

func (*GetEndpointRequest) ProtoReflect

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

func (*GetEndpointRequest) Reset

func (x *GetEndpointRequest) Reset()

func (*GetEndpointRequest) String

func (x *GetEndpointRequest) String() string

type IDSClient

type IDSClient interface {
	// Lists Endpoints in a given project and location.
	ListEndpoints(ctx context.Context, in *ListEndpointsRequest, opts ...grpc.CallOption) (*ListEndpointsResponse, error)
	// Gets details of a single Endpoint.
	GetEndpoint(ctx context.Context, in *GetEndpointRequest, opts ...grpc.CallOption) (*Endpoint, error)
	// Creates a new Endpoint in a given project and location.
	CreateEndpoint(ctx context.Context, in *CreateEndpointRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Endpoint.
	DeleteEndpoint(ctx context.Context, in *DeleteEndpointRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

IDSClient is the client API for IDS service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewIDSClient

func NewIDSClient(cc grpc.ClientConnInterface) IDSClient

type IDSServer

type IDSServer interface {
	// Lists Endpoints in a given project and location.
	ListEndpoints(context.Context, *ListEndpointsRequest) (*ListEndpointsResponse, error)
	// Gets details of a single Endpoint.
	GetEndpoint(context.Context, *GetEndpointRequest) (*Endpoint, error)
	// Creates a new Endpoint in a given project and location.
	CreateEndpoint(context.Context, *CreateEndpointRequest) (*longrunningpb.Operation, error)
	// Deletes a single Endpoint.
	DeleteEndpoint(context.Context, *DeleteEndpointRequest) (*longrunningpb.Operation, error)
}

IDSServer is the server API for IDS service. All implementations should embed UnimplementedIDSServer for forward compatibility

type ListEndpointsRequest

type ListEndpointsRequest struct {

	// Required. The parent, which owns this collection of endpoints.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of endpoints to return. The service may return fewer
	// than this value.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListEndpoints` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListEndpoints` 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. The filter expression, following the syntax outlined in
	// https://google.aip.dev/160.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. One or more fields to compare and use to sort the output.
	// See https://google.aip.dev/132#ordering.
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

func (*ListEndpointsRequest) Descriptor deprecated

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

Deprecated: Use ListEndpointsRequest.ProtoReflect.Descriptor instead.

func (*ListEndpointsRequest) GetFilter

func (x *ListEndpointsRequest) GetFilter() string

func (*ListEndpointsRequest) GetOrderBy

func (x *ListEndpointsRequest) GetOrderBy() string

func (*ListEndpointsRequest) GetPageSize

func (x *ListEndpointsRequest) GetPageSize() int32

func (*ListEndpointsRequest) GetPageToken

func (x *ListEndpointsRequest) GetPageToken() string

func (*ListEndpointsRequest) GetParent

func (x *ListEndpointsRequest) GetParent() string

func (*ListEndpointsRequest) ProtoMessage

func (*ListEndpointsRequest) ProtoMessage()

func (*ListEndpointsRequest) ProtoReflect

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

func (*ListEndpointsRequest) Reset

func (x *ListEndpointsRequest) Reset()

func (*ListEndpointsRequest) String

func (x *ListEndpointsRequest) String() string

type ListEndpointsResponse

type ListEndpointsResponse struct {

	// The list of endpoints response.
	Endpoints []*Endpoint `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,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"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

func (*ListEndpointsResponse) Descriptor deprecated

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

Deprecated: Use ListEndpointsResponse.ProtoReflect.Descriptor instead.

func (*ListEndpointsResponse) GetEndpoints

func (x *ListEndpointsResponse) GetEndpoints() []*Endpoint

func (*ListEndpointsResponse) GetNextPageToken

func (x *ListEndpointsResponse) GetNextPageToken() string

func (*ListEndpointsResponse) GetUnreachable

func (x *ListEndpointsResponse) GetUnreachable() []string

func (*ListEndpointsResponse) ProtoMessage

func (*ListEndpointsResponse) ProtoMessage()

func (*ListEndpointsResponse) ProtoReflect

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

func (*ListEndpointsResponse) Reset

func (x *ListEndpointsResponse) Reset()

func (*ListEndpointsResponse) String

func (x *ListEndpointsResponse) String() string

type OperationMetadata

type OperationMetadata struct {

	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Output only. Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Output only. Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Output only. Identifies whether the user has requested cancellation
	// of the operation. Operations that have successfully been cancelled
	// have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// Output only. API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor deprecated

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetCreateTime

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

func (*OperationMetadata) GetEndTime

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

func (*OperationMetadata) GetRequestedCancellation

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

type UnimplementedIDSServer

type UnimplementedIDSServer struct {
}

UnimplementedIDSServer should be embedded to have forward compatible implementations.

func (UnimplementedIDSServer) CreateEndpoint

func (UnimplementedIDSServer) DeleteEndpoint

func (UnimplementedIDSServer) GetEndpoint

func (UnimplementedIDSServer) ListEndpoints

type UnsafeIDSServer added in v1.5.7

type UnsafeIDSServer interface {
	// contains filtered or unexported methods
}

UnsafeIDSServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to IDSServer will result in compilation errors.

Jump to

Keyboard shortcuts

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