Enum value maps for SecretVersion_State.
var (
SecretVersion_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
3: "DESTROYED",
}
SecretVersion_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
"DESTROYED": 3,
}
)
var File_google_cloud_secretmanager_v1_resources_proto protoreflect.FileDescriptor
var File_google_cloud_secretmanager_v1_service_proto protoreflect.FileDescriptor
func RegisterSecretManagerServiceServer(s *grpc.Server, srv SecretManagerServiceServer)
Request message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].
type AccessSecretVersionRequest struct {
// Required. The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
// `projects/*/secrets/*/versions/*` or
// `projects/*/locations/*/secrets/*/versions/*`.
//
// `projects/*/secrets/*/versions/latest` or
// `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most
// recently created
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessSecretVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use AccessSecretVersionRequest.ProtoReflect.Descriptor instead.
func (x *AccessSecretVersionRequest) GetName() string
func (*AccessSecretVersionRequest) ProtoMessage()
func (x *AccessSecretVersionRequest) ProtoReflect() protoreflect.Message
func (x *AccessSecretVersionRequest) Reset()
func (x *AccessSecretVersionRequest) String() string
Response message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion].
type AccessSecretVersionResponse struct {
// The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
// `projects/*/secrets/*/versions/*` or
// `projects/*/locations/*/secrets/*/versions/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Secret payload
Payload *SecretPayload `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
func (*AccessSecretVersionResponse) Descriptor() ([]byte, []int)
Deprecated: Use AccessSecretVersionResponse.ProtoReflect.Descriptor instead.
func (x *AccessSecretVersionResponse) GetName() string
func (x *AccessSecretVersionResponse) GetPayload() *SecretPayload
func (*AccessSecretVersionResponse) ProtoMessage()
func (x *AccessSecretVersionResponse) ProtoReflect() protoreflect.Message
func (x *AccessSecretVersionResponse) Reset()
func (x *AccessSecretVersionResponse) String() string
Request message for [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion].
type AddSecretVersionRequest struct {
// Required. The resource name of the
// [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
// `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The secret payload of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
Payload *SecretPayload `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
// contains filtered or unexported fields
}
func (*AddSecretVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddSecretVersionRequest.ProtoReflect.Descriptor instead.
func (x *AddSecretVersionRequest) GetParent() string
func (x *AddSecretVersionRequest) GetPayload() *SecretPayload
func (*AddSecretVersionRequest) ProtoMessage()
func (x *AddSecretVersionRequest) ProtoReflect() protoreflect.Message
func (x *AddSecretVersionRequest) Reset()
func (x *AddSecretVersionRequest) String() string
Request message for [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1.SecretManagerService.CreateSecret].
type CreateSecretRequest struct {
// Required. The resource name of the project to associate with the
// [Secret][google.cloud.secretmanager.v1.Secret], in the format `projects/*`
// or `projects/*/locations/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. This must be unique within the project.
//
// A secret ID is a string with a maximum length of 255 characters and can
// contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and
// underscore (`_`) characters.
SecretId string `protobuf:"bytes,2,opt,name=secret_id,json=secretId,proto3" json:"secret_id,omitempty"`
// Required. A [Secret][google.cloud.secretmanager.v1.Secret] with initial
// field values.
Secret *Secret `protobuf:"bytes,3,opt,name=secret,proto3" json:"secret,omitempty"`
// contains filtered or unexported fields
}
func (*CreateSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSecretRequest.ProtoReflect.Descriptor instead.
func (x *CreateSecretRequest) GetParent() string
func (x *CreateSecretRequest) GetSecret() *Secret
func (x *CreateSecretRequest) GetSecretId() string
func (*CreateSecretRequest) ProtoMessage()
func (x *CreateSecretRequest) ProtoReflect() protoreflect.Message
func (x *CreateSecretRequest) Reset()
func (x *CreateSecretRequest) String() string
Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).
type CustomerManagedEncryption struct {
// Required. The resource name of the Cloud KMS CryptoKey used to encrypt
// secret payloads.
//
// For secrets using the
// [UserManaged][google.cloud.secretmanager.v1.Replication.UserManaged]
// replication policy type, Cloud KMS CryptoKeys must reside in the same
// location as the [replica location][Secret.UserManaged.Replica.location].
//
// For secrets using the
// [Automatic][google.cloud.secretmanager.v1.Replication.Automatic]
// replication policy type, Cloud KMS CryptoKeys must reside in `global`.
//
// The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// contains filtered or unexported fields
}
func (*CustomerManagedEncryption) Descriptor() ([]byte, []int)
Deprecated: Use CustomerManagedEncryption.ProtoReflect.Descriptor instead.
func (x *CustomerManagedEncryption) GetKmsKeyName() string
func (*CustomerManagedEncryption) ProtoMessage()
func (x *CustomerManagedEncryption) ProtoReflect() protoreflect.Message
func (x *CustomerManagedEncryption) Reset()
func (x *CustomerManagedEncryption) String() string
Describes the status of customer-managed encryption.
type CustomerManagedEncryptionStatus struct {
// Required. The resource name of the Cloud KMS CryptoKeyVersion used to
// encrypt the secret payload, in the following format:
// `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
KmsKeyVersionName string `protobuf:"bytes,1,opt,name=kms_key_version_name,json=kmsKeyVersionName,proto3" json:"kms_key_version_name,omitempty"`
// contains filtered or unexported fields
}
func (*CustomerManagedEncryptionStatus) Descriptor() ([]byte, []int)
Deprecated: Use CustomerManagedEncryptionStatus.ProtoReflect.Descriptor instead.
func (x *CustomerManagedEncryptionStatus) GetKmsKeyVersionName() string
func (*CustomerManagedEncryptionStatus) ProtoMessage()
func (x *CustomerManagedEncryptionStatus) ProtoReflect() protoreflect.Message
func (x *CustomerManagedEncryptionStatus) Reset()
func (x *CustomerManagedEncryptionStatus) String() string
Request message for [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1.SecretManagerService.DeleteSecret].
type DeleteSecretRequest struct {
// Required. The resource name of the
// [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
// `projects/*/secrets/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Etag of the [Secret][google.cloud.secretmanager.v1.Secret]. The
// request succeeds if it matches the etag of the currently stored secret
// object. If the etag is omitted, the request succeeds.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSecretRequest.ProtoReflect.Descriptor instead.
func (x *DeleteSecretRequest) GetEtag() string
func (x *DeleteSecretRequest) GetName() string
func (*DeleteSecretRequest) ProtoMessage()
func (x *DeleteSecretRequest) ProtoReflect() protoreflect.Message
func (x *DeleteSecretRequest) Reset()
func (x *DeleteSecretRequest) String() string
Request message for [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DestroySecretVersion].
type DestroySecretVersionRequest struct {
// Required. The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in
// the format `projects/*/secrets/*/versions/*` or
// `projects/*/locations/*/secrets/*/versions/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Etag of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. The request
// succeeds if it matches the etag of the currently stored secret version
// object. If the etag is omitted, the request succeeds.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
func (*DestroySecretVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DestroySecretVersionRequest.ProtoReflect.Descriptor instead.
func (x *DestroySecretVersionRequest) GetEtag() string
func (x *DestroySecretVersionRequest) GetName() string
func (*DestroySecretVersionRequest) ProtoMessage()
func (x *DestroySecretVersionRequest) ProtoReflect() protoreflect.Message
func (x *DestroySecretVersionRequest) Reset()
func (x *DestroySecretVersionRequest) String() string
Request message for [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.DisableSecretVersion].
type DisableSecretVersionRequest struct {
// Required. The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in
// the format `projects/*/secrets/*/versions/*` or
// `projects/*/locations/*/secrets/*/versions/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Etag of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. The request
// succeeds if it matches the etag of the currently stored secret version
// object. If the etag is omitted, the request succeeds.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
func (*DisableSecretVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use DisableSecretVersionRequest.ProtoReflect.Descriptor instead.
func (x *DisableSecretVersionRequest) GetEtag() string
func (x *DisableSecretVersionRequest) GetName() string
func (*DisableSecretVersionRequest) ProtoMessage()
func (x *DisableSecretVersionRequest) ProtoReflect() protoreflect.Message
func (x *DisableSecretVersionRequest) Reset()
func (x *DisableSecretVersionRequest) String() string
Request message for [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.EnableSecretVersion].
type EnableSecretVersionRequest struct {
// Required. The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in
// the format `projects/*/secrets/*/versions/*` or
// `projects/*/locations/*/secrets/*/versions/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Etag of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. The request
// succeeds if it matches the etag of the currently stored secret version
// object. If the etag is omitted, the request succeeds.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
func (*EnableSecretVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use EnableSecretVersionRequest.ProtoReflect.Descriptor instead.
func (x *EnableSecretVersionRequest) GetEtag() string
func (x *EnableSecretVersionRequest) GetName() string
func (*EnableSecretVersionRequest) ProtoMessage()
func (x *EnableSecretVersionRequest) ProtoReflect() protoreflect.Message
func (x *EnableSecretVersionRequest) Reset()
func (x *EnableSecretVersionRequest) String() string
Request message for [SecretManagerService.GetSecret][google.cloud.secretmanager.v1.SecretManagerService.GetSecret].
type GetSecretRequest struct {
// Required. The resource name of the
// [Secret][google.cloud.secretmanager.v1.Secret], in the format
// `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSecretRequest.ProtoReflect.Descriptor instead.
func (x *GetSecretRequest) GetName() string
func (*GetSecretRequest) ProtoMessage()
func (x *GetSecretRequest) ProtoReflect() protoreflect.Message
func (x *GetSecretRequest) Reset()
func (x *GetSecretRequest) String() string
Request message for [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.GetSecretVersion].
type GetSecretVersionRequest struct {
// Required. The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
// `projects/*/secrets/*/versions/*` or
// `projects/*/locations/*/secrets/*/versions/*`.
//
// `projects/*/secrets/*/versions/latest` or
// `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most
// recently created
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetSecretVersionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSecretVersionRequest.ProtoReflect.Descriptor instead.
func (x *GetSecretVersionRequest) GetName() string
func (*GetSecretVersionRequest) ProtoMessage()
func (x *GetSecretVersionRequest) ProtoReflect() protoreflect.Message
func (x *GetSecretVersionRequest) Reset()
func (x *GetSecretVersionRequest) String() string
Request message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].
type ListSecretVersionsRequest struct {
// Required. The resource name of the
// [Secret][google.cloud.secretmanager.v1.Secret] associated with the
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] to list, in
// the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of results to be returned in a single page. If
// set to 0, the server decides the number of results to return. If the
// number is greater than 25000, it is capped at 25000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. Pagination token, returned earlier via
// ListSecretVersionsResponse.next_page_token][].
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter string, adhering to the rules in
// [List-operation
// filtering](https://cloud.google.com/secret-manager/docs/filtering). List
// only secret versions matching the filter. If filter is empty, all secret
// versions are listed.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListSecretVersionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSecretVersionsRequest.ProtoReflect.Descriptor instead.
func (x *ListSecretVersionsRequest) GetFilter() string
func (x *ListSecretVersionsRequest) GetPageSize() int32
func (x *ListSecretVersionsRequest) GetPageToken() string
func (x *ListSecretVersionsRequest) GetParent() string
func (*ListSecretVersionsRequest) ProtoMessage()
func (x *ListSecretVersionsRequest) ProtoReflect() protoreflect.Message
func (x *ListSecretVersionsRequest) Reset()
func (x *ListSecretVersionsRequest) String() string
Response message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1.SecretManagerService.ListSecretVersions].
type ListSecretVersionsResponse struct {
// The list of [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]
// sorted in reverse by create_time (newest first).
Versions []*SecretVersion `protobuf:"bytes,1,rep,name=versions,proto3" json:"versions,omitempty"`
// A token to retrieve the next page of results. Pass this value in
// [ListSecretVersionsRequest.page_token][google.cloud.secretmanager.v1.ListSecretVersionsRequest.page_token]
// to retrieve the next page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] but 0 when
// the
// [ListSecretsRequest.filter][google.cloud.secretmanager.v1.ListSecretsRequest.filter]
// field is set.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}
func (*ListSecretVersionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSecretVersionsResponse.ProtoReflect.Descriptor instead.
func (x *ListSecretVersionsResponse) GetNextPageToken() string
func (x *ListSecretVersionsResponse) GetTotalSize() int32
func (x *ListSecretVersionsResponse) GetVersions() []*SecretVersion
func (*ListSecretVersionsResponse) ProtoMessage()
func (x *ListSecretVersionsResponse) ProtoReflect() protoreflect.Message
func (x *ListSecretVersionsResponse) Reset()
func (x *ListSecretVersionsResponse) String() string
Request message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].
type ListSecretsRequest struct {
// Required. The resource name of the project associated with the
// [Secrets][google.cloud.secretmanager.v1.Secret], in the format `projects/*`
// or `projects/*/locations/*`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. The maximum number of results to be returned in a single page. If
// set to 0, the server decides the number of results to return. If the
// number is greater than 25000, it is capped at 25000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. Pagination token, returned earlier via
// [ListSecretsResponse.next_page_token][google.cloud.secretmanager.v1.ListSecretsResponse.next_page_token].
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. Filter string, adhering to the rules in
// [List-operation
// filtering](https://cloud.google.com/secret-manager/docs/filtering). List
// only secrets matching the filter. If filter is empty, all secrets are
// listed.
Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
// contains filtered or unexported fields
}
func (*ListSecretsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSecretsRequest.ProtoReflect.Descriptor instead.
func (x *ListSecretsRequest) GetFilter() string
func (x *ListSecretsRequest) GetPageSize() int32
func (x *ListSecretsRequest) GetPageToken() string
func (x *ListSecretsRequest) GetParent() string
func (*ListSecretsRequest) ProtoMessage()
func (x *ListSecretsRequest) ProtoReflect() protoreflect.Message
func (x *ListSecretsRequest) Reset()
func (x *ListSecretsRequest) String() string
Response message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1.SecretManagerService.ListSecrets].
type ListSecretsResponse struct {
// The list of [Secrets][google.cloud.secretmanager.v1.Secret] sorted in
// reverse by create_time (newest first).
Secrets []*Secret `protobuf:"bytes,1,rep,name=secrets,proto3" json:"secrets,omitempty"`
// A token to retrieve the next page of results. Pass this value in
// [ListSecretsRequest.page_token][google.cloud.secretmanager.v1.ListSecretsRequest.page_token]
// to retrieve the next page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of [Secrets][google.cloud.secretmanager.v1.Secret] but 0
// when the
// [ListSecretsRequest.filter][google.cloud.secretmanager.v1.ListSecretsRequest.filter]
// field is set.
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// contains filtered or unexported fields
}
func (*ListSecretsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSecretsResponse.ProtoReflect.Descriptor instead.
func (x *ListSecretsResponse) GetNextPageToken() string
func (x *ListSecretsResponse) GetSecrets() []*Secret
func (x *ListSecretsResponse) GetTotalSize() int32
func (*ListSecretsResponse) ProtoMessage()
func (x *ListSecretsResponse) ProtoReflect() protoreflect.Message
func (x *ListSecretsResponse) Reset()
func (x *ListSecretsResponse) String() string
A policy that defines the replication and encryption configuration of data.
type Replication struct {
// The replication policy for this secret.
//
// Types that are assignable to Replication:
//
// *Replication_Automatic_
// *Replication_UserManaged_
Replication isReplication_Replication `protobuf_oneof:"replication"`
// contains filtered or unexported fields
}
func (*Replication) Descriptor() ([]byte, []int)
Deprecated: Use Replication.ProtoReflect.Descriptor instead.
func (x *Replication) GetAutomatic() *Replication_Automatic
func (m *Replication) GetReplication() isReplication_Replication
func (x *Replication) GetUserManaged() *Replication_UserManaged
func (*Replication) ProtoMessage()
func (x *Replication) ProtoReflect() protoreflect.Message
func (x *Replication) Reset()
func (x *Replication) String() string
The replication status of a SecretVersion[google.cloud.secretmanager.v1.SecretVersion].
type ReplicationStatus struct {
// The replication status of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Types that are assignable to ReplicationStatus:
//
// *ReplicationStatus_Automatic
// *ReplicationStatus_UserManaged
ReplicationStatus isReplicationStatus_ReplicationStatus `protobuf_oneof:"replication_status"`
// contains filtered or unexported fields
}
func (*ReplicationStatus) Descriptor() ([]byte, []int)
Deprecated: Use ReplicationStatus.ProtoReflect.Descriptor instead.
func (x *ReplicationStatus) GetAutomatic() *ReplicationStatus_AutomaticStatus
func (m *ReplicationStatus) GetReplicationStatus() isReplicationStatus_ReplicationStatus
func (x *ReplicationStatus) GetUserManaged() *ReplicationStatus_UserManagedStatus
func (*ReplicationStatus) ProtoMessage()
func (x *ReplicationStatus) ProtoReflect() protoreflect.Message
func (x *ReplicationStatus) Reset()
func (x *ReplicationStatus) String() string
type ReplicationStatus_Automatic struct {
// Describes the replication status of a
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] with
// automatic replication.
//
// Only populated if the parent
// [Secret][google.cloud.secretmanager.v1.Secret] has an automatic
// replication policy.
Automatic *ReplicationStatus_AutomaticStatus `protobuf:"bytes,1,opt,name=automatic,proto3,oneof"`
}
The replication status of a SecretVersion[google.cloud.secretmanager.v1.SecretVersion] using automatic replication.
Only populated if the parent Secret[google.cloud.secretmanager.v1.Secret] has an automatic replication policy.
type ReplicationStatus_AutomaticStatus struct {
// Output only. The customer-managed encryption status of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only
// populated if customer-managed encryption is used.
CustomerManagedEncryption *CustomerManagedEncryptionStatus `protobuf:"bytes,1,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3" json:"customer_managed_encryption,omitempty"`
// contains filtered or unexported fields
}
func (*ReplicationStatus_AutomaticStatus) Descriptor() ([]byte, []int)
Deprecated: Use ReplicationStatus_AutomaticStatus.ProtoReflect.Descriptor instead.
func (x *ReplicationStatus_AutomaticStatus) GetCustomerManagedEncryption() *CustomerManagedEncryptionStatus
func (*ReplicationStatus_AutomaticStatus) ProtoMessage()
func (x *ReplicationStatus_AutomaticStatus) ProtoReflect() protoreflect.Message
func (x *ReplicationStatus_AutomaticStatus) Reset()
func (x *ReplicationStatus_AutomaticStatus) String() string
type ReplicationStatus_UserManaged struct {
// Describes the replication status of a
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] with
// user-managed replication.
//
// Only populated if the parent
// [Secret][google.cloud.secretmanager.v1.Secret] has a user-managed
// replication policy.
UserManaged *ReplicationStatus_UserManagedStatus `protobuf:"bytes,2,opt,name=user_managed,json=userManaged,proto3,oneof"`
}
The replication status of a SecretVersion[google.cloud.secretmanager.v1.SecretVersion] using user-managed replication.
Only populated if the parent Secret[google.cloud.secretmanager.v1.Secret] has a user-managed replication policy.
type ReplicationStatus_UserManagedStatus struct {
// Output only. The list of replica statuses for the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
Replicas []*ReplicationStatus_UserManagedStatus_ReplicaStatus `protobuf:"bytes,1,rep,name=replicas,proto3" json:"replicas,omitempty"`
// contains filtered or unexported fields
}
func (*ReplicationStatus_UserManagedStatus) Descriptor() ([]byte, []int)
Deprecated: Use ReplicationStatus_UserManagedStatus.ProtoReflect.Descriptor instead.
func (x *ReplicationStatus_UserManagedStatus) GetReplicas() []*ReplicationStatus_UserManagedStatus_ReplicaStatus
func (*ReplicationStatus_UserManagedStatus) ProtoMessage()
func (x *ReplicationStatus_UserManagedStatus) ProtoReflect() protoreflect.Message
func (x *ReplicationStatus_UserManagedStatus) Reset()
func (x *ReplicationStatus_UserManagedStatus) String() string
Describes the status of a user-managed replica for the SecretVersion[google.cloud.secretmanager.v1.SecretVersion].
type ReplicationStatus_UserManagedStatus_ReplicaStatus struct {
// Output only. The canonical ID of the replica location.
// For example: `"us-east1"`.
Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// Output only. The customer-managed encryption status of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only
// populated if customer-managed encryption is used.
CustomerManagedEncryption *CustomerManagedEncryptionStatus `protobuf:"bytes,2,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3" json:"customer_managed_encryption,omitempty"`
// contains filtered or unexported fields
}
func (*ReplicationStatus_UserManagedStatus_ReplicaStatus) Descriptor() ([]byte, []int)
Deprecated: Use ReplicationStatus_UserManagedStatus_ReplicaStatus.ProtoReflect.Descriptor instead.
func (x *ReplicationStatus_UserManagedStatus_ReplicaStatus) GetCustomerManagedEncryption() *CustomerManagedEncryptionStatus
func (x *ReplicationStatus_UserManagedStatus_ReplicaStatus) GetLocation() string
func (*ReplicationStatus_UserManagedStatus_ReplicaStatus) ProtoMessage()
func (x *ReplicationStatus_UserManagedStatus_ReplicaStatus) ProtoReflect() protoreflect.Message
func (x *ReplicationStatus_UserManagedStatus_ReplicaStatus) Reset()
func (x *ReplicationStatus_UserManagedStatus_ReplicaStatus) String() string
A replication policy that replicates the Secret[google.cloud.secretmanager.v1.Secret] payload without any restrictions.
type Replication_Automatic struct {
// Optional. The customer-managed encryption configuration of the
// [Secret][google.cloud.secretmanager.v1.Secret]. If no configuration is
// provided, Google-managed default encryption is used.
//
// Updates to the [Secret][google.cloud.secretmanager.v1.Secret] encryption
// configuration only apply to
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added
// afterwards. They do not apply retroactively to existing
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
CustomerManagedEncryption *CustomerManagedEncryption `protobuf:"bytes,1,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3" json:"customer_managed_encryption,omitempty"`
// contains filtered or unexported fields
}
func (*Replication_Automatic) Descriptor() ([]byte, []int)
Deprecated: Use Replication_Automatic.ProtoReflect.Descriptor instead.
func (x *Replication_Automatic) GetCustomerManagedEncryption() *CustomerManagedEncryption
func (*Replication_Automatic) ProtoMessage()
func (x *Replication_Automatic) ProtoReflect() protoreflect.Message
func (x *Replication_Automatic) Reset()
func (x *Replication_Automatic) String() string
type Replication_Automatic_ struct {
// The [Secret][google.cloud.secretmanager.v1.Secret] will automatically be
// replicated without any restrictions.
Automatic *Replication_Automatic `protobuf:"bytes,1,opt,name=automatic,proto3,oneof"`
}
A replication policy that replicates the Secret[google.cloud.secretmanager.v1.Secret] payload into the locations specified in [Secret.replication.user_managed.replicas][]
type Replication_UserManaged struct {
// Required. The list of Replicas for this
// [Secret][google.cloud.secretmanager.v1.Secret].
//
// Cannot be empty.
Replicas []*Replication_UserManaged_Replica `protobuf:"bytes,1,rep,name=replicas,proto3" json:"replicas,omitempty"`
// contains filtered or unexported fields
}
func (*Replication_UserManaged) Descriptor() ([]byte, []int)
Deprecated: Use Replication_UserManaged.ProtoReflect.Descriptor instead.
func (x *Replication_UserManaged) GetReplicas() []*Replication_UserManaged_Replica
func (*Replication_UserManaged) ProtoMessage()
func (x *Replication_UserManaged) ProtoReflect() protoreflect.Message
func (x *Replication_UserManaged) Reset()
func (x *Replication_UserManaged) String() string
type Replication_UserManaged_ struct {
// The [Secret][google.cloud.secretmanager.v1.Secret] will only be
// replicated into the locations specified.
UserManaged *Replication_UserManaged `protobuf:"bytes,2,opt,name=user_managed,json=userManaged,proto3,oneof"`
}
Represents a Replica for this Secret[google.cloud.secretmanager.v1.Secret].
type Replication_UserManaged_Replica struct {
// The canonical IDs of the location to replicate data.
// For example: `"us-east1"`.
Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
// Optional. The customer-managed encryption configuration of the
// [User-Managed Replica][Replication.UserManaged.Replica]. If no
// configuration is provided, Google-managed default encryption is used.
//
// Updates to the [Secret][google.cloud.secretmanager.v1.Secret]
// encryption configuration only apply to
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added
// afterwards. They do not apply retroactively to existing
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
CustomerManagedEncryption *CustomerManagedEncryption `protobuf:"bytes,2,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3" json:"customer_managed_encryption,omitempty"`
// contains filtered or unexported fields
}
func (*Replication_UserManaged_Replica) Descriptor() ([]byte, []int)
Deprecated: Use Replication_UserManaged_Replica.ProtoReflect.Descriptor instead.
func (x *Replication_UserManaged_Replica) GetCustomerManagedEncryption() *CustomerManagedEncryption
func (x *Replication_UserManaged_Replica) GetLocation() string
func (*Replication_UserManaged_Replica) ProtoMessage()
func (x *Replication_UserManaged_Replica) ProtoReflect() protoreflect.Message
func (x *Replication_UserManaged_Replica) Reset()
func (x *Replication_UserManaged_Replica) String() string
The rotation time and period for a Secret[google.cloud.secretmanager.v1.Secret]. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. [Secret.topics][google.cloud.secretmanager.v1.Secret.topics] must be set to configure rotation.
type Rotation struct {
// Optional. Timestamp in UTC at which the
// [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to rotate.
// Cannot be set to less than 300s (5 min) in the future and at most
// 3153600000s (100 years).
//
// [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
// MUST be set if
// [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
// is set.
NextRotationTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=next_rotation_time,json=nextRotationTime,proto3" json:"next_rotation_time,omitempty"`
// Input only. The Duration between rotation notifications. Must be in seconds
// and at least 3600s (1h) and at most 3153600000s (100 years).
//
// If
// [rotation_period][google.cloud.secretmanager.v1.Rotation.rotation_period]
// is set,
// [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
// must be set.
// [next_rotation_time][google.cloud.secretmanager.v1.Rotation.next_rotation_time]
// will be advanced by this period when the service automatically sends
// rotation notifications.
RotationPeriod *durationpb.Duration `protobuf:"bytes,2,opt,name=rotation_period,json=rotationPeriod,proto3" json:"rotation_period,omitempty"`
// contains filtered or unexported fields
}
func (*Rotation) Descriptor() ([]byte, []int)
Deprecated: Use Rotation.ProtoReflect.Descriptor instead.
func (x *Rotation) GetNextRotationTime() *timestamppb.Timestamp
func (x *Rotation) GetRotationPeriod() *durationpb.Duration
func (*Rotation) ProtoMessage()
func (x *Rotation) ProtoReflect() protoreflect.Message
func (x *Rotation) Reset()
func (x *Rotation) String() string
A Secret[google.cloud.secretmanager.v1.Secret] is a logical secret whose value and versions can be accessed.
A Secret[google.cloud.secretmanager.v1.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] that represent the secret data.
type Secret struct {
// Output only. The resource name of the
// [Secret][google.cloud.secretmanager.v1.Secret] in the format
// `projects/*/secrets/*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Immutable. The replication policy of the secret data attached to
// the [Secret][google.cloud.secretmanager.v1.Secret].
//
// The replication policy cannot be changed after the Secret has been created.
Replication *Replication `protobuf:"bytes,2,opt,name=replication,proto3" json:"replication,omitempty"`
// Output only. The time at which the
// [Secret][google.cloud.secretmanager.v1.Secret] was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The labels assigned to this Secret.
//
// Label keys must be between 1 and 63 characters long, have a UTF-8 encoding
// of maximum 128 bytes, and must conform to the following PCRE regular
// expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`
//
// Label values must be between 0 and 63 characters long, have a UTF-8
// encoding of maximum 128 bytes, and must conform to the following PCRE
// regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`
//
// No more than 64 labels can be assigned to a given resource.
Labels map[string]string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. A list of up to 10 Pub/Sub topics to which messages are published
// when control plane operations are called on the secret or its versions.
Topics []*Topic `protobuf:"bytes,5,rep,name=topics,proto3" json:"topics,omitempty"`
// Expiration policy attached to the
// [Secret][google.cloud.secretmanager.v1.Secret]. If specified the
// [Secret][google.cloud.secretmanager.v1.Secret] and all
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] will be
// automatically deleted at expiration. Expired secrets are irreversibly
// deleted.
//
// Expiration is *not* the recommended way to set time-based permissions. [IAM
// Conditions](https://cloud.google.com/secret-manager/docs/access-control#conditions)
// is recommended for granting time-based permissions because the operation
// can be reversed.
//
// Types that are assignable to Expiration:
//
// *Secret_ExpireTime
// *Secret_Ttl
Expiration isSecret_Expiration `protobuf_oneof:"expiration"`
// Optional. Etag of the currently stored
// [Secret][google.cloud.secretmanager.v1.Secret].
Etag string `protobuf:"bytes,8,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. Rotation policy attached to the
// [Secret][google.cloud.secretmanager.v1.Secret]. May be excluded if there is
// no rotation policy.
Rotation *Rotation `protobuf:"bytes,9,opt,name=rotation,proto3" json:"rotation,omitempty"`
// Optional. Mapping from version alias to version name.
//
// A version alias is a string with a maximum length of 63 characters and can
// contain uppercase and lowercase letters, numerals, and the hyphen (`-`)
// and underscore ('_') characters. An alias string must start with a
// letter and cannot be the string 'latest' or 'NEW'.
// No more than 50 aliases can be assigned to a given secret.
//
// Version-Alias pairs will be viewable via GetSecret and modifiable via
// UpdateSecret. Access by alias is only be supported on
// GetSecretVersion and AccessSecretVersion.
VersionAliases map[string]int64 `protobuf:"bytes,11,rep,name=version_aliases,json=versionAliases,proto3" json:"version_aliases,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"varint,2,opt,name=value,proto3"`
// Optional. Custom metadata about the secret.
//
// Annotations are distinct from various forms of labels.
// Annotations exist to allow client tools to store their own state
// information without requiring a database.
//
// Annotation keys must be between 1 and 63 characters long, have a UTF-8
// encoding of maximum 128 bytes, begin and end with an alphanumeric character
// ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
// alphanumerics in between these symbols.
//
// The total size of annotation keys and values must be less than 16KiB.
Annotations map[string]string `protobuf:"bytes,13,rep,name=annotations,proto3" json:"annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Optional. Secret Version TTL after destruction request
//
// This is a part of the Delayed secret version destroy feature.
// For secret with TTL>0, version destruction doesn't happen immediately
// on calling destroy instead the version goes to a disabled state and
// destruction happens after the TTL expires.
VersionDestroyTtl *durationpb.Duration `protobuf:"bytes,14,opt,name=version_destroy_ttl,json=versionDestroyTtl,proto3" json:"version_destroy_ttl,omitempty"`
// Optional. The customer-managed encryption configuration of the Regionalised
// Secrets. If no configuration is provided, Google-managed default encryption
// is used.
//
// Updates to the [Secret][google.cloud.secretmanager.v1.Secret] encryption
// configuration only apply to
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] added
// afterwards. They do not apply retroactively to existing
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
CustomerManagedEncryption *CustomerManagedEncryption `protobuf:"bytes,15,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3" json:"customer_managed_encryption,omitempty"`
// contains filtered or unexported fields
}
func (*Secret) Descriptor() ([]byte, []int)
Deprecated: Use Secret.ProtoReflect.Descriptor instead.
func (x *Secret) GetAnnotations() map[string]string
func (x *Secret) GetCreateTime() *timestamppb.Timestamp
func (x *Secret) GetCustomerManagedEncryption() *CustomerManagedEncryption
func (x *Secret) GetEtag() string
func (m *Secret) GetExpiration() isSecret_Expiration
func (x *Secret) GetExpireTime() *timestamppb.Timestamp
func (x *Secret) GetLabels() map[string]string
func (x *Secret) GetName() string
func (x *Secret) GetReplication() *Replication
func (x *Secret) GetRotation() *Rotation
func (x *Secret) GetTopics() []*Topic
func (x *Secret) GetTtl() *durationpb.Duration
func (x *Secret) GetVersionAliases() map[string]int64
func (x *Secret) GetVersionDestroyTtl() *durationpb.Duration
func (*Secret) ProtoMessage()
func (x *Secret) ProtoReflect() protoreflect.Message
func (x *Secret) Reset()
func (x *Secret) String() string
SecretManagerServiceClient is the client API for SecretManagerService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type SecretManagerServiceClient interface {
// Lists [Secrets][google.cloud.secretmanager.v1.Secret].
ListSecrets(ctx context.Context, in *ListSecretsRequest, opts ...grpc.CallOption) (*ListSecretsResponse, error)
// Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
CreateSecret(ctx context.Context, in *CreateSecretRequest, opts ...grpc.CallOption) (*Secret, error)
// Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]
// containing secret data and attaches it to an existing
// [Secret][google.cloud.secretmanager.v1.Secret].
AddSecretVersion(ctx context.Context, in *AddSecretVersionRequest, opts ...grpc.CallOption) (*SecretVersion, error)
// Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
GetSecret(ctx context.Context, in *GetSecretRequest, opts ...grpc.CallOption) (*Secret, error)
// Updates metadata of an existing
// [Secret][google.cloud.secretmanager.v1.Secret].
UpdateSecret(ctx context.Context, in *UpdateSecretRequest, opts ...grpc.CallOption) (*Secret, error)
// Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
DeleteSecret(ctx context.Context, in *DeleteSecretRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This
// call does not return secret data.
ListSecretVersions(ctx context.Context, in *ListSecretVersionsRequest, opts ...grpc.CallOption) (*ListSecretVersionsResponse, error)
// Gets metadata for a
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// `projects/*/secrets/*/versions/latest` is an alias to the most recently
// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
GetSecretVersion(ctx context.Context, in *GetSecretVersionRequest, opts ...grpc.CallOption) (*SecretVersion, error)
// Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
// This call returns the secret data.
//
// `projects/*/secrets/*/versions/latest` is an alias to the most recently
// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
AccessSecretVersion(ctx context.Context, in *AccessSecretVersionRequest, opts ...grpc.CallOption) (*AccessSecretVersionResponse, error)
// Disables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
// [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED].
DisableSecretVersion(ctx context.Context, in *DisableSecretVersionRequest, opts ...grpc.CallOption) (*SecretVersion, error)
// Enables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
// [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED].
EnableSecretVersion(ctx context.Context, in *EnableSecretVersionRequest, opts ...grpc.CallOption) (*SecretVersion, error)
// Destroys a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
// [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]
// and irrevocably destroys the secret data.
DestroySecretVersion(ctx context.Context, in *DestroySecretVersionRequest, opts ...grpc.CallOption) (*SecretVersion, error)
// Sets the access control policy on the specified secret. Replaces any
// existing policy.
//
// Permissions on
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced
// according to the policy set on the associated
// [Secret][google.cloud.secretmanager.v1.Secret].
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Gets the access control policy for a secret.
// Returns empty policy if the secret exists and does not have a policy set.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that a caller has for the specified secret.
// If the secret does not exist, this call returns an empty set of
// permissions, not a NOT_FOUND error.
//
// Note: This operation is designed to be used for building permission-aware
// UIs and command-line tools, not for authorization checking. This operation
// may "fail open" without warning.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewSecretManagerServiceClient(cc grpc.ClientConnInterface) SecretManagerServiceClient
SecretManagerServiceServer is the server API for SecretManagerService service.
type SecretManagerServiceServer interface {
// Lists [Secrets][google.cloud.secretmanager.v1.Secret].
ListSecrets(context.Context, *ListSecretsRequest) (*ListSecretsResponse, error)
// Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
CreateSecret(context.Context, *CreateSecretRequest) (*Secret, error)
// Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]
// containing secret data and attaches it to an existing
// [Secret][google.cloud.secretmanager.v1.Secret].
AddSecretVersion(context.Context, *AddSecretVersionRequest) (*SecretVersion, error)
// Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
GetSecret(context.Context, *GetSecretRequest) (*Secret, error)
// Updates metadata of an existing
// [Secret][google.cloud.secretmanager.v1.Secret].
UpdateSecret(context.Context, *UpdateSecretRequest) (*Secret, error)
// Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
DeleteSecret(context.Context, *DeleteSecretRequest) (*emptypb.Empty, error)
// Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This
// call does not return secret data.
ListSecretVersions(context.Context, *ListSecretVersionsRequest) (*ListSecretVersionsResponse, error)
// Gets metadata for a
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// `projects/*/secrets/*/versions/latest` is an alias to the most recently
// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
GetSecretVersion(context.Context, *GetSecretVersionRequest) (*SecretVersion, error)
// Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
// This call returns the secret data.
//
// `projects/*/secrets/*/versions/latest` is an alias to the most recently
// created [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
AccessSecretVersion(context.Context, *AccessSecretVersionRequest) (*AccessSecretVersionResponse, error)
// Disables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
// [DISABLED][google.cloud.secretmanager.v1.SecretVersion.State.DISABLED].
DisableSecretVersion(context.Context, *DisableSecretVersionRequest) (*SecretVersion, error)
// Enables a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
// [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED].
EnableSecretVersion(context.Context, *EnableSecretVersionRequest) (*SecretVersion, error)
// Destroys a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
//
// Sets the [state][google.cloud.secretmanager.v1.SecretVersion.state] of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to
// [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED]
// and irrevocably destroys the secret data.
DestroySecretVersion(context.Context, *DestroySecretVersionRequest) (*SecretVersion, error)
// Sets the access control policy on the specified secret. Replaces any
// existing policy.
//
// Permissions on
// [SecretVersions][google.cloud.secretmanager.v1.SecretVersion] are enforced
// according to the policy set on the associated
// [Secret][google.cloud.secretmanager.v1.Secret].
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Gets the access control policy for a secret.
// Returns empty policy if the secret exists and does not have a policy set.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that a caller has for the specified secret.
// If the secret does not exist, this call returns an empty set of
// permissions, not a NOT_FOUND error.
//
// Note: This operation is designed to be used for building permission-aware
// UIs and command-line tools, not for authorization checking. This operation
// may "fail open" without warning.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion[google.cloud.secretmanager.v1.SecretVersion].
type SecretPayload struct {
// The secret data. Must be no larger than 64KiB.
Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
// Optional. If specified,
// [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService]
// will verify the integrity of the received
// [data][google.cloud.secretmanager.v1.SecretPayload.data] on
// [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]
// calls using the crc32c checksum and store it to include in future
// [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AccessSecretVersion]
// responses. If a checksum is not provided in the
// [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion]
// request, the
// [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService]
// will generate and store one for you.
//
// The CRC32C value is encoded as a Int64 for compatibility, and can be
// safely downconverted to uint32 in languages that support this type.
// https://cloud.google.com/apis/design/design_patterns#integer_types
DataCrc32C *int64 `protobuf:"varint,2,opt,name=data_crc32c,json=dataCrc32c,proto3,oneof" json:"data_crc32c,omitempty"`
// contains filtered or unexported fields
}
func (*SecretPayload) Descriptor() ([]byte, []int)
Deprecated: Use SecretPayload.ProtoReflect.Descriptor instead.
func (x *SecretPayload) GetData() []byte
func (x *SecretPayload) GetDataCrc32C() int64
func (*SecretPayload) ProtoMessage()
func (x *SecretPayload) ProtoReflect() protoreflect.Message
func (x *SecretPayload) Reset()
func (x *SecretPayload) String() string
A secret version resource in the Secret Manager API.
type SecretVersion struct {
// Output only. The resource name of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
// `projects/*/secrets/*/versions/*`.
//
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] IDs in a
// [Secret][google.cloud.secretmanager.v1.Secret] start at 1 and are
// incremented for each subsequent version of the secret.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The time at which the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time this
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] was destroyed.
// Only present if [state][google.cloud.secretmanager.v1.SecretVersion.state]
// is
// [DESTROYED][google.cloud.secretmanager.v1.SecretVersion.State.DESTROYED].
DestroyTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=destroy_time,json=destroyTime,proto3" json:"destroy_time,omitempty"`
// Output only. The current state of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
State SecretVersion_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.cloud.secretmanager.v1.SecretVersion_State" json:"state,omitempty"`
// The replication status of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
ReplicationStatus *ReplicationStatus `protobuf:"bytes,5,opt,name=replication_status,json=replicationStatus,proto3" json:"replication_status,omitempty"`
// Output only. Etag of the currently stored
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
Etag string `protobuf:"bytes,6,opt,name=etag,proto3" json:"etag,omitempty"`
// Output only. True if payload checksum specified in
// [SecretPayload][google.cloud.secretmanager.v1.SecretPayload] object has
// been received by
// [SecretManagerService][google.cloud.secretmanager.v1.SecretManagerService]
// on
// [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1.SecretManagerService.AddSecretVersion].
ClientSpecifiedPayloadChecksum bool `protobuf:"varint,7,opt,name=client_specified_payload_checksum,json=clientSpecifiedPayloadChecksum,proto3" json:"client_specified_payload_checksum,omitempty"`
// Optional. Output only. Scheduled destroy time for secret version.
// This is a part of the Delayed secret version destroy feature. For a
// Secret with a valid version destroy TTL, when a secert version is
// destroyed, the version is moved to disabled state and it is scheduled for
// destruction. The version is destroyed only after the
// `scheduled_destroy_time`.
ScheduledDestroyTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=scheduled_destroy_time,json=scheduledDestroyTime,proto3" json:"scheduled_destroy_time,omitempty"`
// Output only. The customer-managed encryption status of the
// [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. Only
// populated if customer-managed encryption is used and
// [Secret][google.cloud.secretmanager.v1.Secret] is a Regionalised Secret.
CustomerManagedEncryption *CustomerManagedEncryptionStatus `protobuf:"bytes,9,opt,name=customer_managed_encryption,json=customerManagedEncryption,proto3" json:"customer_managed_encryption,omitempty"`
// contains filtered or unexported fields
}
func (*SecretVersion) Descriptor() ([]byte, []int)
Deprecated: Use SecretVersion.ProtoReflect.Descriptor instead.
func (x *SecretVersion) GetClientSpecifiedPayloadChecksum() bool
func (x *SecretVersion) GetCreateTime() *timestamppb.Timestamp
func (x *SecretVersion) GetCustomerManagedEncryption() *CustomerManagedEncryptionStatus
func (x *SecretVersion) GetDestroyTime() *timestamppb.Timestamp
func (x *SecretVersion) GetEtag() string
func (x *SecretVersion) GetName() string
func (x *SecretVersion) GetReplicationStatus() *ReplicationStatus
func (x *SecretVersion) GetScheduledDestroyTime() *timestamppb.Timestamp
func (x *SecretVersion) GetState() SecretVersion_State
func (*SecretVersion) ProtoMessage()
func (x *SecretVersion) ProtoReflect() protoreflect.Message
func (x *SecretVersion) Reset()
func (x *SecretVersion) String() string
The state of a SecretVersion[google.cloud.secretmanager.v1.SecretVersion], indicating if it can be accessed.
type SecretVersion_State int32
const (
// Not specified. This value is unused and invalid.
SecretVersion_STATE_UNSPECIFIED SecretVersion_State = 0
// The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] may be
// accessed.
SecretVersion_ENABLED SecretVersion_State = 1
// The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] may not
// be accessed, but the secret data is still available and can be placed
// back into the
// [ENABLED][google.cloud.secretmanager.v1.SecretVersion.State.ENABLED]
// state.
SecretVersion_DISABLED SecretVersion_State = 2
// The [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] is
// destroyed and the secret data is no longer stored. A version may not
// leave this state once entered.
SecretVersion_DESTROYED SecretVersion_State = 3
)
func (SecretVersion_State) Descriptor() protoreflect.EnumDescriptor
func (x SecretVersion_State) Enum() *SecretVersion_State
func (SecretVersion_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use SecretVersion_State.Descriptor instead.
func (x SecretVersion_State) Number() protoreflect.EnumNumber
func (x SecretVersion_State) String() string
func (SecretVersion_State) Type() protoreflect.EnumType
type Secret_ExpireTime struct {
// Optional. Timestamp in UTC when the
// [Secret][google.cloud.secretmanager.v1.Secret] is scheduled to expire.
// This is always provided on output, regardless of what was sent on input.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=expire_time,json=expireTime,proto3,oneof"`
}
type Secret_Ttl struct {
// Input only. The TTL for the
// [Secret][google.cloud.secretmanager.v1.Secret].
Ttl *durationpb.Duration `protobuf:"bytes,7,opt,name=ttl,proto3,oneof"`
}
A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.
type Topic struct {
// Required. The resource name of the Pub/Sub topic that will be published to,
// in the following format: `projects/*/topics/*`. For publication to succeed,
// the Secret Manager service agent must have the `pubsub.topic.publish`
// permission on the topic. The Pub/Sub Publisher role
// (`roles/pubsub.publisher`) includes this permission.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*Topic) Descriptor() ([]byte, []int)
Deprecated: Use Topic.ProtoReflect.Descriptor instead.
func (x *Topic) GetName() string
func (*Topic) ProtoMessage()
func (x *Topic) ProtoReflect() protoreflect.Message
func (x *Topic) Reset()
func (x *Topic) String() string
UnimplementedSecretManagerServiceServer can be embedded to have forward compatible implementations.
type UnimplementedSecretManagerServiceServer struct {
}
func (*UnimplementedSecretManagerServiceServer) AccessSecretVersion(context.Context, *AccessSecretVersionRequest) (*AccessSecretVersionResponse, error)
func (*UnimplementedSecretManagerServiceServer) AddSecretVersion(context.Context, *AddSecretVersionRequest) (*SecretVersion, error)
func (*UnimplementedSecretManagerServiceServer) CreateSecret(context.Context, *CreateSecretRequest) (*Secret, error)
func (*UnimplementedSecretManagerServiceServer) DeleteSecret(context.Context, *DeleteSecretRequest) (*emptypb.Empty, error)
func (*UnimplementedSecretManagerServiceServer) DestroySecretVersion(context.Context, *DestroySecretVersionRequest) (*SecretVersion, error)
func (*UnimplementedSecretManagerServiceServer) DisableSecretVersion(context.Context, *DisableSecretVersionRequest) (*SecretVersion, error)
func (*UnimplementedSecretManagerServiceServer) EnableSecretVersion(context.Context, *EnableSecretVersionRequest) (*SecretVersion, error)
func (*UnimplementedSecretManagerServiceServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedSecretManagerServiceServer) GetSecret(context.Context, *GetSecretRequest) (*Secret, error)
func (*UnimplementedSecretManagerServiceServer) GetSecretVersion(context.Context, *GetSecretVersionRequest) (*SecretVersion, error)
func (*UnimplementedSecretManagerServiceServer) ListSecretVersions(context.Context, *ListSecretVersionsRequest) (*ListSecretVersionsResponse, error)
func (*UnimplementedSecretManagerServiceServer) ListSecrets(context.Context, *ListSecretsRequest) (*ListSecretsResponse, error)
func (*UnimplementedSecretManagerServiceServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedSecretManagerServiceServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedSecretManagerServiceServer) UpdateSecret(context.Context, *UpdateSecretRequest) (*Secret, error)
Request message for [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1.SecretManagerService.UpdateSecret].
type UpdateSecretRequest struct {
// Required. [Secret][google.cloud.secretmanager.v1.Secret] with updated field
// values.
Secret *Secret `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"`
// Required. Specifies the fields to be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSecretRequest.ProtoReflect.Descriptor instead.
func (x *UpdateSecretRequest) GetSecret() *Secret
func (x *UpdateSecretRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateSecretRequest) ProtoMessage()
func (x *UpdateSecretRequest) ProtoReflect() protoreflect.Message
func (x *UpdateSecretRequest) Reset()
func (x *UpdateSecretRequest) String() string