public class SecretManagerServiceClient : ClientBase<SecretManagerService.SecretManagerServiceClient>
Reference documentation and code samples for the Secret Manager v1 API class SecretManagerService.SecretManagerServiceClient.
Client for SecretManagerService
Inheritance
Object > ClientBase > ClientBase<SecretManagerService.SecretManagerServiceClient> > SecretManagerService.SecretManagerServiceClientNamespace
Google.Cloud.SecretManager.V1Assembly
Google.Cloud.SecretManager.V1.dll
Constructors
SecretManagerServiceClient()
protected SecretManagerServiceClient()
Protected parameterless constructor to allow creation of test doubles.
SecretManagerServiceClient(CallInvoker)
public SecretManagerServiceClient(CallInvoker callInvoker)
Creates a new client for SecretManagerService that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker | CallInvoker The callInvoker to use to make remote calls. |
SecretManagerServiceClient(ChannelBase)
public SecretManagerServiceClient(ChannelBase channel)
Creates a new client for SecretManagerService
Parameter | |
---|---|
Name | Description |
channel | ChannelBase The channel to use to make remote calls. |
SecretManagerServiceClient(ClientBase.ClientBaseConfiguration)
protected SecretManagerServiceClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration The client configuration. |
Methods
AccessSecretVersion(AccessSecretVersionRequest, CallOptions)
public virtual AccessSecretVersionResponse AccessSecretVersion(AccessSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | AccessSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AccessSecretVersionResponse | The response received from the server. |
AccessSecretVersion(AccessSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AccessSecretVersionResponse AccessSecretVersion(AccessSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | AccessSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AccessSecretVersionResponse | The response received from the server. |
AccessSecretVersionAsync(AccessSecretVersionRequest, CallOptions)
public virtual AsyncUnaryCall<AccessSecretVersionResponse> AccessSecretVersionAsync(AccessSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | AccessSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<AccessSecretVersionResponse> | The call object. |
AccessSecretVersionAsync(AccessSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<AccessSecretVersionResponse> AccessSecretVersionAsync(AccessSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | AccessSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<AccessSecretVersionResponse> | The call object. |
AddSecretVersion(AddSecretVersionRequest, CallOptions)
public virtual SecretVersion AddSecretVersion(AddSecretVersionRequest request, CallOptions options)
Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | AddSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
AddSecretVersion(AddSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual SecretVersion AddSecretVersion(AddSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | AddSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
AddSecretVersionAsync(AddSecretVersionRequest, CallOptions)
public virtual AsyncUnaryCall<SecretVersion> AddSecretVersionAsync(AddSecretVersionRequest request, CallOptions options)
Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | AddSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
AddSecretVersionAsync(AddSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<SecretVersion> AddSecretVersionAsync(AddSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | AddSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
CreateSecret(CreateSecretRequest, CallOptions)
public virtual Secret CreateSecret(CreateSecretRequest request, CallOptions options)
Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
Parameters | |
---|---|
Name | Description |
request | CreateSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Secret | The response received from the server. |
CreateSecret(CreateSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Secret CreateSecret(CreateSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
Parameters | |
---|---|
Name | Description |
request | CreateSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Secret | The response received from the server. |
CreateSecretAsync(CreateSecretRequest, CallOptions)
public virtual AsyncUnaryCall<Secret> CreateSecretAsync(CreateSecretRequest request, CallOptions options)
Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
Parameters | |
---|---|
Name | Description |
request | CreateSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Secret> | The call object. |
CreateSecretAsync(CreateSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Secret> CreateSecretAsync(CreateSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
Parameters | |
---|---|
Name | Description |
request | CreateSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Secret> | The call object. |
DeleteSecret(DeleteSecretRequest, CallOptions)
public virtual Empty DeleteSecret(DeleteSecretRequest request, CallOptions options)
Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | DeleteSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
DeleteSecret(DeleteSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteSecret(DeleteSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | DeleteSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
DeleteSecretAsync(DeleteSecretRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteSecretAsync(DeleteSecretRequest request, CallOptions options)
Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | DeleteSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Empty> | The call object. |
DeleteSecretAsync(DeleteSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteSecretAsync(DeleteSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | DeleteSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Empty> | The call object. |
DestroySecretVersion(DestroySecretVersionRequest, CallOptions)
public virtual SecretVersion DestroySecretVersion(DestroySecretVersionRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request | DestroySecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
DestroySecretVersion(DestroySecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual SecretVersion DestroySecretVersion(DestroySecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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.
Parameters | |
---|---|
Name | Description |
request | DestroySecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
DestroySecretVersionAsync(DestroySecretVersionRequest, CallOptions)
public virtual AsyncUnaryCall<SecretVersion> DestroySecretVersionAsync(DestroySecretVersionRequest request, CallOptions options)
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.
Parameters | |
---|---|
Name | Description |
request | DestroySecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
DestroySecretVersionAsync(DestroySecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<SecretVersion> DestroySecretVersionAsync(DestroySecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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.
Parameters | |
---|---|
Name | Description |
request | DestroySecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
DisableSecretVersion(DisableSecretVersionRequest, CallOptions)
public virtual SecretVersion DisableSecretVersion(DisableSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | DisableSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
DisableSecretVersion(DisableSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual SecretVersion DisableSecretVersion(DisableSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | DisableSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
DisableSecretVersionAsync(DisableSecretVersionRequest, CallOptions)
public virtual AsyncUnaryCall<SecretVersion> DisableSecretVersionAsync(DisableSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | DisableSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
DisableSecretVersionAsync(DisableSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<SecretVersion> DisableSecretVersionAsync(DisableSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | DisableSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
EnableSecretVersion(EnableSecretVersionRequest, CallOptions)
public virtual SecretVersion EnableSecretVersion(EnableSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | EnableSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
EnableSecretVersion(EnableSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual SecretVersion EnableSecretVersion(EnableSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | EnableSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
EnableSecretVersionAsync(EnableSecretVersionRequest, CallOptions)
public virtual AsyncUnaryCall<SecretVersion> EnableSecretVersionAsync(EnableSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | EnableSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
EnableSecretVersionAsync(EnableSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<SecretVersion> EnableSecretVersionAsync(EnableSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | EnableSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
GetIamPolicy(GetIamPolicyRequest, CallOptions)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)
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 | GetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Policy | The response received from the server. |
GetIamPolicy(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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 | GetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Policy | The response received from the server. |
GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)
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 | GetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Policy> | The call object. |
GetIamPolicyAsync(GetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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 | GetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Policy> | The call object. |
GetSecret(GetSecretRequest, CallOptions)
public virtual Secret GetSecret(GetSecretRequest request, CallOptions options)
Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | GetSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Secret | The response received from the server. |
GetSecret(GetSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Secret GetSecret(GetSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | GetSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Secret | The response received from the server. |
GetSecretAsync(GetSecretRequest, CallOptions)
public virtual AsyncUnaryCall<Secret> GetSecretAsync(GetSecretRequest request, CallOptions options)
Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | GetSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Secret> | The call object. |
GetSecretAsync(GetSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Secret> GetSecretAsync(GetSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | GetSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Secret> | The call object. |
GetSecretVersion(GetSecretVersionRequest, CallOptions)
public virtual SecretVersion GetSecretVersion(GetSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | GetSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
GetSecretVersion(GetSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual SecretVersion GetSecretVersion(GetSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | GetSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
SecretVersion | The response received from the server. |
GetSecretVersionAsync(GetSecretVersionRequest, CallOptions)
public virtual AsyncUnaryCall<SecretVersion> GetSecretVersionAsync(GetSecretVersionRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | GetSecretVersionRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
GetSecretVersionAsync(GetSecretVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<SecretVersion> GetSecretVersionAsync(GetSecretVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | GetSecretVersionRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<SecretVersion> | The call object. |
ListSecrets(ListSecretsRequest, CallOptions)
public virtual ListSecretsResponse ListSecrets(ListSecretsRequest request, CallOptions options)
Lists [Secrets][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | ListSecretsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListSecretsResponse | The response received from the server. |
ListSecrets(ListSecretsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListSecretsResponse ListSecrets(ListSecretsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Lists [Secrets][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | ListSecretsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListSecretsResponse | The response received from the server. |
ListSecretsAsync(ListSecretsRequest, CallOptions)
public virtual AsyncUnaryCall<ListSecretsResponse> ListSecretsAsync(ListSecretsRequest request, CallOptions options)
Lists [Secrets][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | ListSecretsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListSecretsResponse> | The call object. |
ListSecretsAsync(ListSecretsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListSecretsResponse> ListSecretsAsync(ListSecretsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Lists [Secrets][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | ListSecretsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListSecretsResponse> | The call object. |
ListSecretVersions(ListSecretVersionsRequest, CallOptions)
public virtual ListSecretVersionsResponse ListSecretVersions(ListSecretVersionsRequest request, CallOptions options)
Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
Parameters | |
---|---|
Name | Description |
request | ListSecretVersionsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListSecretVersionsResponse | The response received from the server. |
ListSecretVersions(ListSecretVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListSecretVersionsResponse ListSecretVersions(ListSecretVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
Parameters | |
---|---|
Name | Description |
request | ListSecretVersionsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListSecretVersionsResponse | The response received from the server. |
ListSecretVersionsAsync(ListSecretVersionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListSecretVersionsResponse> ListSecretVersionsAsync(ListSecretVersionsRequest request, CallOptions options)
Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
Parameters | |
---|---|
Name | Description |
request | ListSecretVersionsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListSecretVersionsResponse> | The call object. |
ListSecretVersionsAsync(ListSecretVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListSecretVersionsResponse> ListSecretVersionsAsync(ListSecretVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
Parameters | |
---|---|
Name | Description |
request | ListSecretVersionsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<ListSecretVersionsResponse> | The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override SecretManagerService.SecretManagerServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration | ClientBase.ClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
SecretManagerService.SecretManagerServiceClient |
SetIamPolicy(SetIamPolicyRequest, CallOptions)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Policy | The response received from the server. |
SetIamPolicy(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Policy | The response received from the server. |
SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)
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].
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Policy> | The call object. |
SetIamPolicyAsync(SetIamPolicyRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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].
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Policy> | The call object. |
TestIamPermissions(TestIamPermissionsRequest, CallOptions)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)
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 | TestIamPermissionsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse | The response received from the server. |
TestIamPermissions(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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 | TestIamPermissionsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse | The response received from the server. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)
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 | TestIamPermissionsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<TestIamPermissionsResponse> | The call object. |
TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
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 | TestIamPermissionsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<TestIamPermissionsResponse> | The call object. |
UpdateSecret(UpdateSecretRequest, CallOptions)
public virtual Secret UpdateSecret(UpdateSecretRequest request, CallOptions options)
Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | UpdateSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Secret | The response received from the server. |
UpdateSecret(UpdateSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Secret UpdateSecret(UpdateSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | UpdateSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Secret | The response received from the server. |
UpdateSecretAsync(UpdateSecretRequest, CallOptions)
public virtual AsyncUnaryCall<Secret> UpdateSecretAsync(UpdateSecretRequest request, CallOptions options)
Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | UpdateSecretRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Secret> | The call object. |
UpdateSecretAsync(UpdateSecretRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Secret> UpdateSecretAsync(UpdateSecretRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))
Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
Parameters | |
---|---|
Name | Description |
request | UpdateSecretRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime> An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCall<Secret> | The call object. |