inventorypb

package
v1.23.1 Latest Latest
Warning

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

Go to latest
Published: Oct 7, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	KeyTrackingService_GetProtectedResourcesSummary_FullMethodName = "/google.cloud.kms.inventory.v1.KeyTrackingService/GetProtectedResourcesSummary"
	KeyTrackingService_SearchProtectedResources_FullMethodName     = "/google.cloud.kms.inventory.v1.KeyTrackingService/SearchProtectedResources"
)
View Source
const (
	KeyDashboardService_ListCryptoKeys_FullMethodName = "/google.cloud.kms.inventory.v1.KeyDashboardService/ListCryptoKeys"
)

Variables

View Source
var File_google_cloud_kms_inventory_v1_key_dashboard_service_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_kms_inventory_v1_key_tracking_service_proto protoreflect.FileDescriptor
View Source
var KeyDashboardService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.kms.inventory.v1.KeyDashboardService",
	HandlerType: (*KeyDashboardServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListCryptoKeys",
			Handler:    _KeyDashboardService_ListCryptoKeys_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/kms/inventory/v1/key_dashboard_service.proto",
}

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

View Source
var KeyTrackingService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.kms.inventory.v1.KeyTrackingService",
	HandlerType: (*KeyTrackingServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetProtectedResourcesSummary",
			Handler:    _KeyTrackingService_GetProtectedResourcesSummary_Handler,
		},
		{
			MethodName: "SearchProtectedResources",
			Handler:    _KeyTrackingService_SearchProtectedResources_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/kms/inventory/v1/key_tracking_service.proto",
}

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

Functions

func RegisterKeyDashboardServiceServer

func RegisterKeyDashboardServiceServer(s grpc.ServiceRegistrar, srv KeyDashboardServiceServer)

func RegisterKeyTrackingServiceServer

func RegisterKeyTrackingServiceServer(s grpc.ServiceRegistrar, srv KeyTrackingServiceServer)

Types

type GetProtectedResourcesSummaryRequest

type GetProtectedResourcesSummaryRequest struct {

	// Required. The resource name of the
	// [CryptoKey][google.cloud.kms.v1.CryptoKey].
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for [KeyTrackingService.GetProtectedResourcesSummary][google.cloud.kms.inventory.v1.KeyTrackingService.GetProtectedResourcesSummary].

func (*GetProtectedResourcesSummaryRequest) Descriptor deprecated

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

Deprecated: Use GetProtectedResourcesSummaryRequest.ProtoReflect.Descriptor instead.

func (*GetProtectedResourcesSummaryRequest) GetName

func (*GetProtectedResourcesSummaryRequest) ProtoMessage

func (*GetProtectedResourcesSummaryRequest) ProtoMessage()

func (*GetProtectedResourcesSummaryRequest) ProtoReflect

func (*GetProtectedResourcesSummaryRequest) Reset

func (*GetProtectedResourcesSummaryRequest) String

type KeyDashboardServiceClient

type KeyDashboardServiceClient interface {
	// Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
	// Note that this data is sourced from snapshots, meaning it may not
	// completely reflect the actual state of key metadata at call time.
	ListCryptoKeys(ctx context.Context, in *ListCryptoKeysRequest, opts ...grpc.CallOption) (*ListCryptoKeysResponse, error)
}

KeyDashboardServiceClient is the client API for KeyDashboardService 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.

type KeyDashboardServiceServer

type KeyDashboardServiceServer interface {
	// Returns cryptographic keys managed by Cloud KMS in a given Cloud project.
	// Note that this data is sourced from snapshots, meaning it may not
	// completely reflect the actual state of key metadata at call time.
	ListCryptoKeys(context.Context, *ListCryptoKeysRequest) (*ListCryptoKeysResponse, error)
}

KeyDashboardServiceServer is the server API for KeyDashboardService service. All implementations should embed UnimplementedKeyDashboardServiceServer for forward compatibility

type KeyTrackingServiceClient

type KeyTrackingServiceClient interface {
	// Returns aggregate information about the resources protected by the given
	// Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey]. Only resources within
	// the same Cloud organization as the key will be returned. The project that
	// holds the key must be part of an organization in order for this call to
	// succeed.
	GetProtectedResourcesSummary(ctx context.Context, in *GetProtectedResourcesSummaryRequest, opts ...grpc.CallOption) (*ProtectedResourcesSummary, error)
	// Returns metadata about the resources protected by the given Cloud KMS
	// [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.
	SearchProtectedResources(ctx context.Context, in *SearchProtectedResourcesRequest, opts ...grpc.CallOption) (*SearchProtectedResourcesResponse, error)
}

KeyTrackingServiceClient is the client API for KeyTrackingService 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.

type KeyTrackingServiceServer

type KeyTrackingServiceServer interface {
	// Returns aggregate information about the resources protected by the given
	// Cloud KMS [CryptoKey][google.cloud.kms.v1.CryptoKey]. Only resources within
	// the same Cloud organization as the key will be returned. The project that
	// holds the key must be part of an organization in order for this call to
	// succeed.
	GetProtectedResourcesSummary(context.Context, *GetProtectedResourcesSummaryRequest) (*ProtectedResourcesSummary, error)
	// Returns metadata about the resources protected by the given Cloud KMS
	// [CryptoKey][google.cloud.kms.v1.CryptoKey] in the given Cloud organization.
	SearchProtectedResources(context.Context, *SearchProtectedResourcesRequest) (*SearchProtectedResourcesResponse, error)
}

KeyTrackingServiceServer is the server API for KeyTrackingService service. All implementations should embed UnimplementedKeyTrackingServiceServer for forward compatibility

type ListCryptoKeysRequest

type ListCryptoKeysRequest struct {

	// Required. The Google Cloud project for which to retrieve key metadata, in
	// the format `projects/*`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of keys to return. The service may return
	// fewer than this value. If unspecified, at most 1000 keys 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"`
	// Optional. Pass this into a subsequent request in order to receive the next
	// page of results.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for [KeyDashboardService.ListCryptoKeys][google.cloud.kms.inventory.v1.KeyDashboardService.ListCryptoKeys].

func (*ListCryptoKeysRequest) Descriptor deprecated

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

Deprecated: Use ListCryptoKeysRequest.ProtoReflect.Descriptor instead.

func (*ListCryptoKeysRequest) GetPageSize

func (x *ListCryptoKeysRequest) GetPageSize() int32

func (*ListCryptoKeysRequest) GetPageToken

func (x *ListCryptoKeysRequest) GetPageToken() string

func (*ListCryptoKeysRequest) GetParent

func (x *ListCryptoKeysRequest) GetParent() string

func (*ListCryptoKeysRequest) ProtoMessage

func (*ListCryptoKeysRequest) ProtoMessage()

func (*ListCryptoKeysRequest) ProtoReflect

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

func (*ListCryptoKeysRequest) Reset

func (x *ListCryptoKeysRequest) Reset()

func (*ListCryptoKeysRequest) String

func (x *ListCryptoKeysRequest) String() string

type ListCryptoKeysResponse

type ListCryptoKeysResponse struct {

	// The list of [CryptoKeys][google.cloud.kms.v1.CryptoKey].
	CryptoKeys []*kmspb.CryptoKey `protobuf:"bytes,1,rep,name=crypto_keys,json=cryptoKeys,proto3" json:"crypto_keys,omitempty"`
	// The page token returned from the previous response if the next page is
	// desired.
	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 [KeyDashboardService.ListCryptoKeys][google.cloud.kms.inventory.v1.KeyDashboardService.ListCryptoKeys].

func (*ListCryptoKeysResponse) Descriptor deprecated

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

Deprecated: Use ListCryptoKeysResponse.ProtoReflect.Descriptor instead.

func (*ListCryptoKeysResponse) GetCryptoKeys

func (x *ListCryptoKeysResponse) GetCryptoKeys() []*kmspb.CryptoKey

func (*ListCryptoKeysResponse) GetNextPageToken

func (x *ListCryptoKeysResponse) GetNextPageToken() string

func (*ListCryptoKeysResponse) ProtoMessage

func (*ListCryptoKeysResponse) ProtoMessage()

func (*ListCryptoKeysResponse) ProtoReflect

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

func (*ListCryptoKeysResponse) Reset

func (x *ListCryptoKeysResponse) Reset()

func (*ListCryptoKeysResponse) String

func (x *ListCryptoKeysResponse) String() string

type ProtectedResource

type ProtectedResource struct {

	// The full resource name of the resource.
	// Example:
	// `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Format: `projects/{PROJECT_NUMBER}`.
	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
	// The ID of the project that owns the resource.
	ProjectId string `protobuf:"bytes,9,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The Cloud product that owns the resource.
	// Example: `compute`
	CloudProduct string `protobuf:"bytes,8,opt,name=cloud_product,json=cloudProduct,proto3" json:"cloud_product,omitempty"`
	// Example: `compute.googleapis.com/Disk`
	ResourceType string `protobuf:"bytes,3,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`
	// Location can be `global`, regional like `us-east1`, or zonal like
	// `us-west1-b`.
	Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"`
	// A key-value pair of the resource's labels (v1) to their values.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// The name of the Cloud KMS
	// [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en)
	// used to protect this resource via CMEK. This field is empty if the
	// Google Cloud product owning the resource does not provide key version data
	// to Asset Inventory. If there are multiple key versions protecting the
	// resource, then this is same value as the first element of
	// crypto_key_versions.
	CryptoKeyVersion string `protobuf:"bytes,6,opt,name=crypto_key_version,json=cryptoKeyVersion,proto3" json:"crypto_key_version,omitempty"`
	// The names of the Cloud KMS
	// [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions?hl=en)
	// used to protect this resource via CMEK. This field is empty if the
	// Google Cloud product owning the resource does not provide key versions data
	// to Asset Inventory. The first element of this field is stored in
	// crypto_key_version.
	CryptoKeyVersions []string `protobuf:"bytes,10,rep,name=crypto_key_versions,json=cryptoKeyVersions,proto3" json:"crypto_key_versions,omitempty"`
	// Output only. The time at which this resource was created. The granularity
	// is in seconds. Timestamp.nanos will always be 0.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata about a resource protected by a Cloud KMS key.

func (*ProtectedResource) Descriptor deprecated

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

Deprecated: Use ProtectedResource.ProtoReflect.Descriptor instead.

func (*ProtectedResource) GetCloudProduct

func (x *ProtectedResource) GetCloudProduct() string

func (*ProtectedResource) GetCreateTime

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

func (*ProtectedResource) GetCryptoKeyVersion

func (x *ProtectedResource) GetCryptoKeyVersion() string

func (*ProtectedResource) GetCryptoKeyVersions

func (x *ProtectedResource) GetCryptoKeyVersions() []string

func (*ProtectedResource) GetLabels

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

func (*ProtectedResource) GetLocation

func (x *ProtectedResource) GetLocation() string

func (*ProtectedResource) GetName

func (x *ProtectedResource) GetName() string

func (*ProtectedResource) GetProject

func (x *ProtectedResource) GetProject() string

func (*ProtectedResource) GetProjectId

func (x *ProtectedResource) GetProjectId() string

func (*ProtectedResource) GetResourceType

func (x *ProtectedResource) GetResourceType() string

func (*ProtectedResource) ProtoMessage

func (*ProtectedResource) ProtoMessage()

func (*ProtectedResource) ProtoReflect

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

func (*ProtectedResource) Reset

func (x *ProtectedResource) Reset()

func (*ProtectedResource) String

func (x *ProtectedResource) String() string

type ProtectedResourcesSummary

type ProtectedResourcesSummary struct {

	// The full name of the ProtectedResourcesSummary resource.
	// Example:
	// projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary
	Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`
	// The total number of protected resources in the same Cloud organization as
	// the key.
	ResourceCount int64 `protobuf:"varint,1,opt,name=resource_count,json=resourceCount,proto3" json:"resource_count,omitempty"`
	// The number of distinct Cloud projects in the same Cloud organization as the
	// key that have resources protected by the key.
	ProjectCount int32 `protobuf:"varint,2,opt,name=project_count,json=projectCount,proto3" json:"project_count,omitempty"`
	// The number of resources protected by the key grouped by resource type.
	ResourceTypes map[string]int64 `` /* 189-byte string literal not displayed */
	// The number of resources protected by the key grouped by Cloud product.
	CloudProducts map[string]int64 `` /* 189-byte string literal not displayed */
	// The number of resources protected by the key grouped by region.
	Locations map[string]int64 `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

Aggregate information about the resources protected by a Cloud KMS key in the same Cloud organization as the key.

func (*ProtectedResourcesSummary) Descriptor deprecated

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

Deprecated: Use ProtectedResourcesSummary.ProtoReflect.Descriptor instead.

func (*ProtectedResourcesSummary) GetCloudProducts

func (x *ProtectedResourcesSummary) GetCloudProducts() map[string]int64

func (*ProtectedResourcesSummary) GetLocations

func (x *ProtectedResourcesSummary) GetLocations() map[string]int64

func (*ProtectedResourcesSummary) GetName

func (x *ProtectedResourcesSummary) GetName() string

func (*ProtectedResourcesSummary) GetProjectCount

func (x *ProtectedResourcesSummary) GetProjectCount() int32

func (*ProtectedResourcesSummary) GetResourceCount

func (x *ProtectedResourcesSummary) GetResourceCount() int64

func (*ProtectedResourcesSummary) GetResourceTypes

func (x *ProtectedResourcesSummary) GetResourceTypes() map[string]int64

func (*ProtectedResourcesSummary) ProtoMessage

func (*ProtectedResourcesSummary) ProtoMessage()

func (*ProtectedResourcesSummary) ProtoReflect

func (*ProtectedResourcesSummary) Reset

func (x *ProtectedResourcesSummary) Reset()

func (*ProtectedResourcesSummary) String

func (x *ProtectedResourcesSummary) String() string

type SearchProtectedResourcesRequest

type SearchProtectedResourcesRequest struct {

	// Required. Resource name of the organization.
	// Example: organizations/123
	Scope string `protobuf:"bytes,2,opt,name=scope,proto3" json:"scope,omitempty"`
	// Required. The resource name of the
	// [CryptoKey][google.cloud.kms.v1.CryptoKey].
	CryptoKey string `protobuf:"bytes,1,opt,name=crypto_key,json=cryptoKey,proto3" json:"crypto_key,omitempty"`
	// The maximum number of resources to return. The service may return fewer
	// than this value.
	// If unspecified, at most 500 resources will be returned.
	// The maximum value is 500; values above 500 will be coerced to 500.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous
	// [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources]
	// call. Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to
	// [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources]
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A list of resource types that this request searches for. If
	// empty, it will search all the [trackable resource
	// types](https://cloud.google.com/kms/docs/view-key-usage#tracked-resource-types).
	//
	// Regular expressions are also supported. For example:
	//
	// * `compute.googleapis.com.*` snapshots resources whose type starts
	// with `compute.googleapis.com`.
	// * `.*Image` snapshots resources whose type ends with `Image`.
	// * `.*Image.*` snapshots resources whose type contains `Image`.
	//
	// See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported
	// regular expression syntax. If the regular expression does not match any
	// supported resource type, an INVALID_ARGUMENT error will be returned.
	ResourceTypes []string `protobuf:"bytes,5,rep,name=resource_types,json=resourceTypes,proto3" json:"resource_types,omitempty"`
	// contains filtered or unexported fields
}

Request message for [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources].

func (*SearchProtectedResourcesRequest) Descriptor deprecated

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

Deprecated: Use SearchProtectedResourcesRequest.ProtoReflect.Descriptor instead.

func (*SearchProtectedResourcesRequest) GetCryptoKey

func (x *SearchProtectedResourcesRequest) GetCryptoKey() string

func (*SearchProtectedResourcesRequest) GetPageSize

func (x *SearchProtectedResourcesRequest) GetPageSize() int32

func (*SearchProtectedResourcesRequest) GetPageToken

func (x *SearchProtectedResourcesRequest) GetPageToken() string

func (*SearchProtectedResourcesRequest) GetResourceTypes added in v1.14.0

func (x *SearchProtectedResourcesRequest) GetResourceTypes() []string

func (*SearchProtectedResourcesRequest) GetScope

func (*SearchProtectedResourcesRequest) ProtoMessage

func (*SearchProtectedResourcesRequest) ProtoMessage()

func (*SearchProtectedResourcesRequest) ProtoReflect

func (*SearchProtectedResourcesRequest) Reset

func (*SearchProtectedResourcesRequest) String

type SearchProtectedResourcesResponse

type SearchProtectedResourcesResponse struct {

	// Protected resources for this page.
	ProtectedResources []*ProtectedResource `protobuf:"bytes,1,rep,name=protected_resources,json=protectedResources,proto3" json:"protected_resources,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 [KeyTrackingService.SearchProtectedResources][google.cloud.kms.inventory.v1.KeyTrackingService.SearchProtectedResources].

func (*SearchProtectedResourcesResponse) Descriptor deprecated

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

Deprecated: Use SearchProtectedResourcesResponse.ProtoReflect.Descriptor instead.

func (*SearchProtectedResourcesResponse) GetNextPageToken

func (x *SearchProtectedResourcesResponse) GetNextPageToken() string

func (*SearchProtectedResourcesResponse) GetProtectedResources

func (x *SearchProtectedResourcesResponse) GetProtectedResources() []*ProtectedResource

func (*SearchProtectedResourcesResponse) ProtoMessage

func (*SearchProtectedResourcesResponse) ProtoMessage()

func (*SearchProtectedResourcesResponse) ProtoReflect

func (*SearchProtectedResourcesResponse) Reset

func (*SearchProtectedResourcesResponse) String

type UnimplementedKeyDashboardServiceServer

type UnimplementedKeyDashboardServiceServer struct {
}

UnimplementedKeyDashboardServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedKeyDashboardServiceServer) ListCryptoKeys

type UnimplementedKeyTrackingServiceServer

type UnimplementedKeyTrackingServiceServer struct {
}

UnimplementedKeyTrackingServiceServer should be embedded to have forward compatible implementations.

type UnsafeKeyDashboardServiceServer added in v1.23.1

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

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

type UnsafeKeyTrackingServiceServer added in v1.23.1

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

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

Jump to

Keyboard shortcuts

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