Package cloud.google.com/go/kms/inventory/apiv1/inventorypb (v1.15.8)

Version latest

• 1.15.8 (latest)
• 1.15.7
• 1.14.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

File_google_cloud_kms_inventory_v1_key_dashboard_service_proto

var File_google_cloud_kms_inventory_v1_key_dashboard_service_proto protoreflect.FileDescriptor

File_google_cloud_kms_inventory_v1_key_tracking_service_proto

var File_google_cloud_kms_inventory_v1_key_tracking_service_proto protoreflect.FileDescriptor

Functions

func RegisterKeyDashboardServiceServer

func RegisterKeyDashboardServiceServer(s *grpc.Server, srv KeyDashboardServiceServer)

func RegisterKeyTrackingServiceServer

func RegisterKeyTrackingServiceServer(s *grpc.Server, srv KeyTrackingServiceServer)

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

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

Deprecated: Use GetProtectedResourcesSummaryRequest.ProtoReflect.Descriptor instead.

func (*GetProtectedResourcesSummaryRequest) GetName

func (x *GetProtectedResourcesSummaryRequest) GetName() string

func (*GetProtectedResourcesSummaryRequest) ProtoMessage

func (*GetProtectedResourcesSummaryRequest) ProtoMessage()

func (*GetProtectedResourcesSummaryRequest) ProtoReflect

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

func (*GetProtectedResourcesSummaryRequest) Reset

func (x *GetProtectedResourcesSummaryRequest) Reset()

func (*GetProtectedResourcesSummaryRequest) String

func (x *GetProtectedResourcesSummaryRequest) String() string

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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewKeyDashboardServiceClient

func NewKeyDashboardServiceClient(cc grpc.ClientConnInterface) KeyDashboardServiceClient

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.

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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewKeyTrackingServiceClient

func NewKeyTrackingServiceClient(cc grpc.ClientConnInterface) KeyTrackingServiceClient

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.

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

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

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

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

ProtectedResource

type ProtectedResource struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`

	ProjectId string `protobuf:"bytes,9,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`

	CloudProduct string `protobuf:"bytes,8,opt,name=cloud_product,json=cloudProduct,proto3" json:"cloud_product,omitempty"`

	ResourceType string `protobuf:"bytes,3,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`

	Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

	CryptoKeyVersion string `protobuf:"bytes,6,opt,name=crypto_key_version,json=cryptoKeyVersion,proto3" json:"crypto_key_version,omitempty"`

	CryptoKeyVersions []string `protobuf:"bytes,10,rep,name=crypto_key_versions,json=cryptoKeyVersions,proto3" json:"crypto_key_versions,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

}

Metadata about a resource protected by a Cloud KMS key.

func (*ProtectedResource) Descriptor

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

ProtectedResourcesSummary

type ProtectedResourcesSummary struct {
	Name string `protobuf:"bytes,5,opt,name=name,proto3" json:"name,omitempty"`

	ResourceCount int64 `protobuf:"varint,1,opt,name=resource_count,json=resourceCount,proto3" json:"resource_count,omitempty"`

	ProjectCount int32 `protobuf:"varint,2,opt,name=project_count,json=projectCount,proto3" json:"project_count,omitempty"`

	ResourceTypes map[string]int64 "" /* 189 byte string literal not displayed */

	CloudProducts map[string]int64 "" /* 189 byte string literal not displayed */

	Locations map[string]int64 "" /* 160 byte string literal not displayed */

}

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

func (*ProtectedResourcesSummary) Descriptor

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 (x *ProtectedResourcesSummary) ProtoReflect() protoreflect.Message

func (*ProtectedResourcesSummary) Reset

func (x *ProtectedResourcesSummary) Reset()

func (*ProtectedResourcesSummary) String

func (x *ProtectedResourcesSummary) String() string

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

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

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

func (*SearchProtectedResourcesRequest) GetScope

func (x *SearchProtectedResourcesRequest) GetScope() string

func (*SearchProtectedResourcesRequest) ProtoMessage

func (*SearchProtectedResourcesRequest) ProtoMessage()

func (*SearchProtectedResourcesRequest) ProtoReflect

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

func (*SearchProtectedResourcesRequest) Reset

func (x *SearchProtectedResourcesRequest) Reset()

func (*SearchProtectedResourcesRequest) String

func (x *SearchProtectedResourcesRequest) String() string

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

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 (x *SearchProtectedResourcesResponse) ProtoReflect() protoreflect.Message

func (*SearchProtectedResourcesResponse) Reset

func (x *SearchProtectedResourcesResponse) Reset()

func (*SearchProtectedResourcesResponse) String

func (x *SearchProtectedResourcesResponse) String() string

UnimplementedKeyDashboardServiceServer

type UnimplementedKeyDashboardServiceServer struct {
}

UnimplementedKeyDashboardServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedKeyDashboardServiceServer) ListCryptoKeys

func (*UnimplementedKeyDashboardServiceServer) ListCryptoKeys(context.Context, *ListCryptoKeysRequest) (*ListCryptoKeysResponse, error)

UnimplementedKeyTrackingServiceServer

type UnimplementedKeyTrackingServiceServer struct {
}

UnimplementedKeyTrackingServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedKeyTrackingServiceServer) GetProtectedResourcesSummary

func (*UnimplementedKeyTrackingServiceServer) GetProtectedResourcesSummary(context.Context, *GetProtectedResourcesSummaryRequest) (*ProtectedResourcesSummary, error)

func (*UnimplementedKeyTrackingServiceServer) SearchProtectedResources

func (*UnimplementedKeyTrackingServiceServer) SearchProtectedResources(context.Context, *SearchProtectedResourcesRequest) (*SearchProtectedResourcesResponse, error)