public sealed class SecretManagerServiceClientImpl : SecretManagerServiceClientSecretManagerService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.SecretManager.V1Beta1Assembly
Google.Cloud.SecretManager.V1Beta1.dll
Remarks
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- [Secret][google.cloud.secrets.v1beta1.Secret]
- [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]
Constructors
SecretManagerServiceClientImpl(SecretManagerService.SecretManagerServiceClient, SecretManagerServiceSettings)
public SecretManagerServiceClientImpl(SecretManagerService.SecretManagerServiceClient grpcClient, SecretManagerServiceSettings settings)Constructs a client wrapper for the SecretManagerService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | SecretManagerService.SecretManagerServiceClientThe underlying gRPC client. |
settings | SecretManagerServiceSettingsThe base SecretManagerServiceSettings used within this client. |
Properties
GrpcClient
public override SecretManagerService.SecretManagerServiceClient GrpcClient { get; }The underlying gRPC SecretManagerService client
| Property Value | |
|---|---|
| Type | Description |
SecretManagerService.SecretManagerServiceClient | |
Methods
AccessSecretVersion(AccessSecretVersionRequest, CallSettings)
public override AccessSecretVersionResponse AccessSecretVersion(AccessSecretVersionRequest request, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request | AccessSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AccessSecretVersionResponse | The RPC response. |
AccessSecretVersionAsync(AccessSecretVersionRequest, CallSettings)
public override Task<AccessSecretVersionResponse> AccessSecretVersionAsync(AccessSecretVersionRequest request, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request | AccessSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<AccessSecretVersionResponse> | A Task containing the RPC response. |
AddSecretVersion(AddSecretVersionRequest, CallSettings)
public override SecretVersion AddSecretVersion(AddSecretVersionRequest request, CallSettings callSettings = null)Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | AddSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion | The RPC response. |
AddSecretVersionAsync(AddSecretVersionRequest, CallSettings)
public override Task<SecretVersion> AddSecretVersionAsync(AddSecretVersionRequest request, CallSettings callSettings = null)Creates a new [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | AddSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<SecretVersion> | A Task containing the RPC response. |
CreateSecret(CreateSecretRequest, CallSettings)
public override Secret CreateSecret(CreateSecretRequest request, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request | CreateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret | The RPC response. |
CreateSecretAsync(CreateSecretRequest, CallSettings)
public override Task<Secret> CreateSecretAsync(CreateSecretRequest request, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secrets.v1beta1.Secret] containing no [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request | CreateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Secret> | A Task containing the RPC response. |
DeleteSecret(DeleteSecretRequest, CallSettings)
public override void DeleteSecret(DeleteSecretRequest request, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteSecretAsync(DeleteSecretRequest, CallSettings)
public override Task DeleteSecretAsync(DeleteSecretRequest request, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DestroySecretVersion(DestroySecretVersionRequest, CallSettings)
public override SecretVersion DestroySecretVersion(DestroySecretVersionRequest request, CallSettings callSettings = null)Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably destroys the secret data.
| Parameters | |
|---|---|
| Name | Description |
request | DestroySecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion | The RPC response. |
DestroySecretVersionAsync(DestroySecretVersionRequest, CallSettings)
public override Task<SecretVersion> DestroySecretVersionAsync(DestroySecretVersionRequest request, CallSettings callSettings = null)Destroys a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED] and irrevocably destroys the secret data.
| Parameters | |
|---|---|
| Name | Description |
request | DestroySecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<SecretVersion> | A Task containing the RPC response. |
DisableSecretVersion(DisableSecretVersionRequest, CallSettings)
public override SecretVersion DisableSecretVersion(DisableSecretVersionRequest request, CallSettings callSettings = null)Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED].
| Parameters | |
|---|---|
| Name | Description |
request | DisableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion | The RPC response. |
DisableSecretVersionAsync(DisableSecretVersionRequest, CallSettings)
public override Task<SecretVersion> DisableSecretVersionAsync(DisableSecretVersionRequest request, CallSettings callSettings = null)Disables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [DISABLED][google.cloud.secrets.v1beta1.SecretVersion.State.DISABLED].
| Parameters | |
|---|---|
| Name | Description |
request | DisableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<SecretVersion> | A Task containing the RPC response. |
EnableSecretVersion(EnableSecretVersionRequest, CallSettings)
public override SecretVersion EnableSecretVersion(EnableSecretVersionRequest request, CallSettings callSettings = null)Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED].
| Parameters | |
|---|---|
| Name | Description |
request | EnableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion | The RPC response. |
EnableSecretVersionAsync(EnableSecretVersionRequest, CallSettings)
public override Task<SecretVersion> EnableSecretVersionAsync(EnableSecretVersionRequest request, CallSettings callSettings = null)Enables a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
Sets the [state][google.cloud.secrets.v1beta1.SecretVersion.state] of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion] to [ENABLED][google.cloud.secrets.v1beta1.SecretVersion.State.ENABLED].
| Parameters | |
|---|---|
| Name | Description |
request | EnableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<SecretVersion> | A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.
| Parameters | |
|---|---|
| Name | Description |
request | GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Policy> | A Task containing the RPC response. |
GetSecret(GetSecretRequest, CallSettings)
public override Secret GetSecret(GetSecretRequest request, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | GetSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret | The RPC response. |
GetSecretAsync(GetSecretRequest, CallSettings)
public override Task<Secret> GetSecretAsync(GetSecretRequest request, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | GetSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Secret> | A Task containing the RPC response. |
GetSecretVersion(GetSecretVersionRequest, CallSettings)
public override SecretVersion GetSecretVersion(GetSecretVersionRequest request, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request | GetSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion | The RPC response. |
GetSecretVersionAsync(GetSecretVersionRequest, CallSettings)
public override Task<SecretVersion> GetSecretVersionAsync(GetSecretVersionRequest request, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request | GetSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<SecretVersion> | A Task containing the RPC response. |
ListSecrets(ListSecretsRequest, CallSettings)
public override PagedEnumerable<ListSecretsResponse, Secret> ListSecrets(ListSecretsRequest request, CallSettings callSettings = null)Lists [Secrets][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | ListSecretsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListSecretsResponse, Secret> | A pageable sequence of Secret resources. |
ListSecretsAsync(ListSecretsRequest, CallSettings)
public override PagedAsyncEnumerable<ListSecretsResponse, Secret> ListSecretsAsync(ListSecretsRequest request, CallSettings callSettings = null)Lists [Secrets][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | ListSecretsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListSecretsResponse, Secret> | A pageable asynchronous sequence of Secret resources. |
ListSecretVersions(ListSecretVersionsRequest, CallSettings)
public override PagedEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersions(ListSecretVersionsRequest request, CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return secret data.
| Parameters | |
|---|---|
| Name | Description |
request | ListSecretVersionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListSecretVersionsResponse, SecretVersion> | A pageable sequence of SecretVersion resources. |
ListSecretVersionsAsync(ListSecretVersionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersionsAsync(ListSecretVersionsRequest request, CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion]. This call does not return secret data.
| Parameters | |
|---|---|
| Name | Description |
request | ListSecretVersionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> | A pageable asynchronous sequence of SecretVersion resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on the specified secret. Replaces any existing policy.
Permissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)Sets the access control policy on the specified secret. Replaces any existing policy.
Permissions on [SecretVersions][google.cloud.secrets.v1beta1.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Policy> | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<TestIamPermissionsResponse> | A Task containing the RPC response. |
UpdateSecret(UpdateSecretRequest, CallSettings)
public override Secret UpdateSecret(UpdateSecretRequest request, CallSettings callSettings = null)Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret | The RPC response. |
UpdateSecretAsync(UpdateSecretRequest, CallSettings)
public override Task<Secret> UpdateSecretAsync(UpdateSecretRequest request, CallSettings callSettings = null)Updates metadata of an existing [Secret][google.cloud.secrets.v1beta1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request | UpdateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Secret> | A Task containing the RPC response. |