public abstract class SecretManagerServiceClientSecretManagerService client wrapper, for convenient use.
Inheritance
System.Object > SecretManagerServiceClientNamespace
Google.Cloud.SecretManager.V1Assembly
Google.Cloud.SecretManager.V1.dll
Remarks
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- [Secret][google.cloud.secretmanager.v1.Secret]
- [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }The default endpoint for the SecretManagerService service, which is a host of "secretmanager.googleapis.com" and a port of 443.
| Property Value | |
|---|---|
| Type | Description |
System.String |
|
DefaultScopes
public static IReadOnlyList<string> DefaultScopes { get; }The default SecretManagerService scopes.
| Property Value | |
|---|---|
| Type | Description |
System.Collections.Generic.IReadOnlyList<System.String> |
|
The default SecretManagerService scopes are:
GrpcClient
public virtual SecretManagerService.SecretManagerServiceClient GrpcClient { get; }The underlying gRPC SecretManagerService client
| Property Value | |
|---|---|
| Type | Description |
SecretManagerService.SecretManagerServiceClient |
|
Methods
AccessSecretVersion(AccessSecretVersionRequest, CallSettings)
public virtual AccessSecretVersionResponse AccessSecretVersion(AccessSecretVersionRequest request, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
AccessSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AccessSecretVersionResponse |
The RPC response. |
AccessSecretVersion(SecretVersionName, CallSettings)
public virtual AccessSecretVersionResponse AccessSecretVersion(SecretVersionName name, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AccessSecretVersionResponse |
The RPC response. |
AccessSecretVersion(String, CallSettings)
public virtual AccessSecretVersionResponse AccessSecretVersion(string name, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AccessSecretVersionResponse |
The RPC response. |
AccessSecretVersionAsync(AccessSecretVersionRequest, CallSettings)
public virtual Task<AccessSecretVersionResponse> AccessSecretVersionAsync(AccessSecretVersionRequest request, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
AccessSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<AccessSecretVersionResponse> |
A Task containing the RPC response. |
AccessSecretVersionAsync(AccessSecretVersionRequest, CancellationToken)
public virtual Task<AccessSecretVersionResponse> AccessSecretVersionAsync(AccessSecretVersionRequest request, CancellationToken cancellationToken)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
AccessSecretVersionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<AccessSecretVersionResponse> |
A Task containing the RPC response. |
AccessSecretVersionAsync(SecretVersionName, CallSettings)
public virtual Task<AccessSecretVersionResponse> AccessSecretVersionAsync(SecretVersionName name, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<AccessSecretVersionResponse> |
A Task containing the RPC response. |
AccessSecretVersionAsync(SecretVersionName, CancellationToken)
public virtual Task<AccessSecretVersionResponse> AccessSecretVersionAsync(SecretVersionName name, CancellationToken cancellationToken)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<AccessSecretVersionResponse> |
A Task containing the RPC response. |
AccessSecretVersionAsync(String, CallSettings)
public virtual Task<AccessSecretVersionResponse> AccessSecretVersionAsync(string name, CallSettings callSettings = null)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<AccessSecretVersionResponse> |
A Task containing the RPC response. |
AccessSecretVersionAsync(String, CancellationToken)
public virtual Task<AccessSecretVersionResponse> AccessSecretVersionAsync(string name, CancellationToken cancellationToken)Accesses a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. This call returns the secret data.
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<AccessSecretVersionResponse> |
A Task containing the RPC response. |
AddSecretVersion(AddSecretVersionRequest, CallSettings)
public virtual SecretVersion AddSecretVersion(AddSecretVersionRequest request, CallSettings callSettings = null)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 |
AddSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
AddSecretVersion(SecretName, SecretPayload, CallSettings)
public virtual SecretVersion AddSecretVersion(SecretName parent, SecretPayload payload, CallSettings callSettings = null)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 |
parent |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format |
payload |
SecretPayloadRequired. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
AddSecretVersion(String, SecretPayload, CallSettings)
public virtual SecretVersion AddSecretVersion(string parent, SecretPayload payload, CallSettings callSettings = null)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 |
parent |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format |
payload |
SecretPayloadRequired. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
AddSecretVersionAsync(AddSecretVersionRequest, CallSettings)
public virtual Task<SecretVersion> AddSecretVersionAsync(AddSecretVersionRequest request, CallSettings callSettings = null)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 |
AddSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
AddSecretVersionAsync(AddSecretVersionRequest, CancellationToken)
public virtual Task<SecretVersion> AddSecretVersionAsync(AddSecretVersionRequest request, CancellationToken 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 |
AddSecretVersionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
AddSecretVersionAsync(SecretName, SecretPayload, CallSettings)
public virtual Task<SecretVersion> AddSecretVersionAsync(SecretName parent, SecretPayload payload, CallSettings callSettings = null)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 |
parent |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format |
payload |
SecretPayloadRequired. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
AddSecretVersionAsync(SecretName, SecretPayload, CancellationToken)
public virtual Task<SecretVersion> AddSecretVersionAsync(SecretName parent, SecretPayload payload, CancellationToken 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 |
parent |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format |
payload |
SecretPayloadRequired. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
AddSecretVersionAsync(String, SecretPayload, CallSettings)
public virtual Task<SecretVersion> AddSecretVersionAsync(string parent, SecretPayload payload, CallSettings callSettings = null)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 |
parent |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format |
payload |
SecretPayloadRequired. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
AddSecretVersionAsync(String, SecretPayload, CancellationToken)
public virtual Task<SecretVersion> AddSecretVersionAsync(string parent, SecretPayload payload, CancellationToken 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 |
parent |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to associate with the
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format |
payload |
SecretPayloadRequired. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion]. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
Create()
public static SecretManagerServiceClient Create()Synchronously creates a SecretManagerServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SecretManagerServiceClientBuilder.
| Returns | |
|---|---|
| Type | Description |
SecretManagerServiceClient |
The created SecretManagerServiceClient. |
CreateAsync(CancellationToken)
public static Task<SecretManagerServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))Asynchronously creates a SecretManagerServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use SecretManagerServiceClientBuilder.
| Parameter | |
|---|---|
| Name | Description |
cancellationToken |
System.Threading.CancellationTokenThe System.Threading.CancellationToken to use while creating the client. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretManagerServiceClient> |
The task representing the created SecretManagerServiceClient. |
CreateSecret(ProjectName, String, Secret, CallSettings)
public virtual Secret CreateSecret(ProjectName parent, string secretId, Secret secret, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
parent |
Google.Api.Gax.ResourceNames.ProjectNameRequired. The resource name of the project to associate with the
[Secret][google.cloud.secretmanager.v1.Secret], in the format |
secretId |
System.StringRequired. 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 ( |
secret |
SecretRequired. A [Secret][google.cloud.secretmanager.v1.Secret] with initial field values. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
CreateSecret(CreateSecretRequest, CallSettings)
public virtual Secret CreateSecret(CreateSecretRequest request, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
CreateSecret(String, String, Secret, CallSettings)
public virtual Secret CreateSecret(string parent, string secretId, Secret secret, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. The resource name of the project to associate with the
[Secret][google.cloud.secretmanager.v1.Secret], in the format |
secretId |
System.StringRequired. 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 ( |
secret |
SecretRequired. A [Secret][google.cloud.secretmanager.v1.Secret] with initial field values. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
CreateSecretAsync(ProjectName, String, Secret, CallSettings)
public virtual Task<Secret> CreateSecretAsync(ProjectName parent, string secretId, Secret secret, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
parent |
Google.Api.Gax.ResourceNames.ProjectNameRequired. The resource name of the project to associate with the
[Secret][google.cloud.secretmanager.v1.Secret], in the format |
secretId |
System.StringRequired. 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 ( |
secret |
SecretRequired. A [Secret][google.cloud.secretmanager.v1.Secret] with initial field values. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
CreateSecretAsync(ProjectName, String, Secret, CancellationToken)
public virtual Task<Secret> CreateSecretAsync(ProjectName parent, string secretId, Secret secret, CancellationToken cancellationToken)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
parent |
Google.Api.Gax.ResourceNames.ProjectNameRequired. The resource name of the project to associate with the
[Secret][google.cloud.secretmanager.v1.Secret], in the format |
secretId |
System.StringRequired. 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 ( |
secret |
SecretRequired. A [Secret][google.cloud.secretmanager.v1.Secret] with initial field values. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
CreateSecretAsync(CreateSecretRequest, CallSettings)
public virtual Task<Secret> CreateSecretAsync(CreateSecretRequest request, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
CreateSecretAsync(CreateSecretRequest, CancellationToken)
public virtual Task<Secret> CreateSecretAsync(CreateSecretRequest request, CancellationToken cancellationToken)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
CreateSecretRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
CreateSecretAsync(String, String, Secret, CallSettings)
public virtual Task<Secret> CreateSecretAsync(string parent, string secretId, Secret secret, CallSettings callSettings = null)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. The resource name of the project to associate with the
[Secret][google.cloud.secretmanager.v1.Secret], in the format |
secretId |
System.StringRequired. 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 ( |
secret |
SecretRequired. A [Secret][google.cloud.secretmanager.v1.Secret] with initial field values. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
CreateSecretAsync(String, String, Secret, CancellationToken)
public virtual Task<Secret> CreateSecretAsync(string parent, string secretId, Secret secret, CancellationToken cancellationToken)Creates a new [Secret][google.cloud.secretmanager.v1.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. The resource name of the project to associate with the
[Secret][google.cloud.secretmanager.v1.Secret], in the format |
secretId |
System.StringRequired. 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 ( |
secret |
SecretRequired. A [Secret][google.cloud.secretmanager.v1.Secret] with initial field values. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
DeleteSecret(DeleteSecretRequest, CallSettings)
public virtual void DeleteSecret(DeleteSecretRequest request, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
DeleteSecret(SecretName, CallSettings)
public virtual void DeleteSecret(SecretName name, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
DeleteSecret(String, CallSettings)
public virtual void DeleteSecret(string name, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
DeleteSecretAsync(DeleteSecretRequest, CallSettings)
public virtual Task DeleteSecretAsync(DeleteSecretRequest request, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A Task containing the RPC response. |
DeleteSecretAsync(DeleteSecretRequest, CancellationToken)
public virtual Task DeleteSecretAsync(DeleteSecretRequest request, CancellationToken cancellationToken)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSecretRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A Task containing the RPC response. |
DeleteSecretAsync(SecretName, CallSettings)
public virtual Task DeleteSecretAsync(SecretName name, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A Task containing the RPC response. |
DeleteSecretAsync(SecretName, CancellationToken)
public virtual Task DeleteSecretAsync(SecretName name, CancellationToken cancellationToken)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A Task containing the RPC response. |
DeleteSecretAsync(String, CallSettings)
public virtual Task DeleteSecretAsync(string name, CallSettings callSettings = null)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A Task containing the RPC response. |
DeleteSecretAsync(String, CancellationToken)
public virtual Task DeleteSecretAsync(string name, CancellationToken cancellationToken)Deletes a [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret] to delete in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A Task containing the RPC response. |
DestroySecretVersion(DestroySecretVersionRequest, CallSettings)
public virtual SecretVersion DestroySecretVersion(DestroySecretVersionRequest request, CallSettings callSettings = null)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 |
DestroySecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
DestroySecretVersion(SecretVersionName, CallSettings)
public virtual SecretVersion DestroySecretVersion(SecretVersionName name, CallSettings callSettings = null)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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
DestroySecretVersion(String, CallSettings)
public virtual SecretVersion DestroySecretVersion(string name, CallSettings callSettings = null)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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
DestroySecretVersionAsync(DestroySecretVersionRequest, CallSettings)
public virtual Task<SecretVersion> DestroySecretVersionAsync(DestroySecretVersionRequest request, CallSettings callSettings = null)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 |
DestroySecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DestroySecretVersionAsync(DestroySecretVersionRequest, CancellationToken)
public virtual Task<SecretVersion> DestroySecretVersionAsync(DestroySecretVersionRequest request, CancellationToken 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 |
DestroySecretVersionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DestroySecretVersionAsync(SecretVersionName, CallSettings)
public virtual Task<SecretVersion> DestroySecretVersionAsync(SecretVersionName name, CallSettings callSettings = null)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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DestroySecretVersionAsync(SecretVersionName, CancellationToken)
public virtual Task<SecretVersion> DestroySecretVersionAsync(SecretVersionName name, CancellationToken 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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DestroySecretVersionAsync(String, CallSettings)
public virtual Task<SecretVersion> DestroySecretVersionAsync(string name, CallSettings callSettings = null)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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DestroySecretVersionAsync(String, CancellationToken)
public virtual Task<SecretVersion> DestroySecretVersionAsync(string name, CancellationToken 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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to destroy in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DisableSecretVersion(DisableSecretVersionRequest, CallSettings)
public virtual SecretVersion DisableSecretVersion(DisableSecretVersionRequest request, CallSettings callSettings = null)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 |
DisableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
DisableSecretVersion(SecretVersionName, CallSettings)
public virtual SecretVersion DisableSecretVersion(SecretVersionName name, CallSettings callSettings = null)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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
DisableSecretVersion(String, CallSettings)
public virtual SecretVersion DisableSecretVersion(string name, CallSettings callSettings = null)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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
DisableSecretVersionAsync(DisableSecretVersionRequest, CallSettings)
public virtual Task<SecretVersion> DisableSecretVersionAsync(DisableSecretVersionRequest request, CallSettings callSettings = null)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 |
DisableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DisableSecretVersionAsync(DisableSecretVersionRequest, CancellationToken)
public virtual Task<SecretVersion> DisableSecretVersionAsync(DisableSecretVersionRequest request, CancellationToken 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 |
DisableSecretVersionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DisableSecretVersionAsync(SecretVersionName, CallSettings)
public virtual Task<SecretVersion> DisableSecretVersionAsync(SecretVersionName name, CallSettings callSettings = null)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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DisableSecretVersionAsync(SecretVersionName, CancellationToken)
public virtual Task<SecretVersion> DisableSecretVersionAsync(SecretVersionName name, CancellationToken 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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DisableSecretVersionAsync(String, CallSettings)
public virtual Task<SecretVersion> DisableSecretVersionAsync(string name, CallSettings callSettings = null)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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
DisableSecretVersionAsync(String, CancellationToken)
public virtual Task<SecretVersion> DisableSecretVersionAsync(string name, CancellationToken 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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to disable in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
EnableSecretVersion(EnableSecretVersionRequest, CallSettings)
public virtual SecretVersion EnableSecretVersion(EnableSecretVersionRequest request, CallSettings callSettings = null)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 |
EnableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
EnableSecretVersion(SecretVersionName, CallSettings)
public virtual SecretVersion EnableSecretVersion(SecretVersionName name, CallSettings callSettings = null)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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
EnableSecretVersion(String, CallSettings)
public virtual SecretVersion EnableSecretVersion(string name, CallSettings callSettings = null)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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
EnableSecretVersionAsync(EnableSecretVersionRequest, CallSettings)
public virtual Task<SecretVersion> EnableSecretVersionAsync(EnableSecretVersionRequest request, CallSettings callSettings = null)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 |
EnableSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
EnableSecretVersionAsync(EnableSecretVersionRequest, CancellationToken)
public virtual Task<SecretVersion> EnableSecretVersionAsync(EnableSecretVersionRequest request, CancellationToken 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 |
EnableSecretVersionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
EnableSecretVersionAsync(SecretVersionName, CallSettings)
public virtual Task<SecretVersion> EnableSecretVersionAsync(SecretVersionName name, CallSettings callSettings = null)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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
EnableSecretVersionAsync(SecretVersionName, CancellationToken)
public virtual Task<SecretVersion> EnableSecretVersionAsync(SecretVersionName name, CancellationToken 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 |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
EnableSecretVersionAsync(String, CallSettings)
public virtual Task<SecretVersion> EnableSecretVersionAsync(string name, CallSettings callSettings = null)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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
EnableSecretVersionAsync(String, CancellationToken)
public virtual Task<SecretVersion> EnableSecretVersionAsync(string name, CancellationToken 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 |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] to enable in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public virtual 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 |
Google.Cloud.Iam.V1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Cloud.Iam.V1.Policy |
The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public virtual 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 |
Google.Cloud.Iam.V1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> |
A Task containing the RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CancellationToken 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 |
Google.Cloud.Iam.V1.GetIamPolicyRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> |
A Task containing the RPC response. |
GetSecret(GetSecretRequest, CallSettings)
public virtual Secret GetSecret(GetSecretRequest request, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
GetSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
GetSecret(SecretName, CallSettings)
public virtual Secret GetSecret(SecretName name, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret], in the format |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
GetSecret(String, CallSettings)
public virtual Secret GetSecret(string name, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret], in the format |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
GetSecretAsync(GetSecretRequest, CallSettings)
public virtual Task<Secret> GetSecretAsync(GetSecretRequest request, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
GetSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
GetSecretAsync(GetSecretRequest, CancellationToken)
public virtual Task<Secret> GetSecretAsync(GetSecretRequest request, CancellationToken cancellationToken)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
GetSecretRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
GetSecretAsync(SecretName, CallSettings)
public virtual Task<Secret> GetSecretAsync(SecretName name, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret], in the format |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
GetSecretAsync(SecretName, CancellationToken)
public virtual Task<Secret> GetSecretAsync(SecretName name, CancellationToken cancellationToken)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretNameRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret], in the format |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
GetSecretAsync(String, CallSettings)
public virtual Task<Secret> GetSecretAsync(string name, CallSettings callSettings = null)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret], in the format |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
GetSecretAsync(String, CancellationToken)
public virtual Task<Secret> GetSecretAsync(string name, CancellationToken cancellationToken)Gets metadata for a given [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [Secret][google.cloud.secretmanager.v1.Secret], in the format |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
GetSecretVersion(GetSecretVersionRequest, CallSettings)
public virtual SecretVersion GetSecretVersion(GetSecretVersionRequest request, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
GetSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
GetSecretVersion(SecretVersionName, CallSettings)
public virtual SecretVersion GetSecretVersion(SecretVersionName name, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
GetSecretVersion(String, CallSettings)
public virtual SecretVersion GetSecretVersion(string name, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SecretVersion |
The RPC response. |
GetSecretVersionAsync(GetSecretVersionRequest, CallSettings)
public virtual Task<SecretVersion> GetSecretVersionAsync(GetSecretVersionRequest request, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
GetSecretVersionRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
GetSecretVersionAsync(GetSecretVersionRequest, CancellationToken)
public virtual Task<SecretVersion> GetSecretVersionAsync(GetSecretVersionRequest request, CancellationToken cancellationToken)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
request |
GetSecretVersionRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
GetSecretVersionAsync(SecretVersionName, CallSettings)
public virtual Task<SecretVersion> GetSecretVersionAsync(SecretVersionName name, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
GetSecretVersionAsync(SecretVersionName, CancellationToken)
public virtual Task<SecretVersion> GetSecretVersionAsync(SecretVersionName name, CancellationToken cancellationToken)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
SecretVersionNameRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
GetSecretVersionAsync(String, CallSettings)
public virtual Task<SecretVersion> GetSecretVersionAsync(string name, CallSettings callSettings = null)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
GetSecretVersionAsync(String, CancellationToken)
public virtual Task<SecretVersion> GetSecretVersionAsync(string name, CancellationToken cancellationToken)Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
projects/*/secrets/*/versions/latest is an alias to the latest
[SecretVersion][google.cloud.secretmanager.v1.SecretVersion].
| Parameters | |
|---|---|
| Name | Description |
name |
System.StringRequired. The resource name of the [SecretVersion][google.cloud.secretmanager.v1.SecretVersion] in the format
|
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<SecretVersion> |
A Task containing the RPC response. |
ListSecrets(ProjectName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListSecretsResponse, Secret> ListSecrets(ProjectName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [Secrets][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
parent |
Google.Api.Gax.ResourceNames.ProjectNameRequired. The resource name of the project associated with the
[Secrets][google.cloud.secretmanager.v1.Secret], in the format |
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedEnumerable<ListSecretsResponse, Secret> |
A pageable sequence of Secret resources. |
ListSecrets(ListSecretsRequest, CallSettings)
public virtual PagedEnumerable<ListSecretsResponse, Secret> ListSecrets(ListSecretsRequest request, CallSettings callSettings = null)Lists [Secrets][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
ListSecretsRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedEnumerable<ListSecretsResponse, Secret> |
A pageable sequence of Secret resources. |
ListSecrets(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListSecretsResponse, Secret> ListSecrets(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [Secrets][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. The resource name of the project associated with the
[Secrets][google.cloud.secretmanager.v1.Secret], in the format |
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedEnumerable<ListSecretsResponse, Secret> |
A pageable sequence of Secret resources. |
ListSecretsAsync(ProjectName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListSecretsResponse, Secret> ListSecretsAsync(ProjectName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [Secrets][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
parent |
Google.Api.Gax.ResourceNames.ProjectNameRequired. The resource name of the project associated with the
[Secrets][google.cloud.secretmanager.v1.Secret], in the format |
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListSecretsResponse, Secret> |
A pageable asynchronous sequence of Secret resources. |
ListSecretsAsync(ListSecretsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListSecretsResponse, Secret> ListSecretsAsync(ListSecretsRequest request, CallSettings callSettings = null)Lists [Secrets][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
ListSecretsRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListSecretsResponse, Secret> |
A pageable asynchronous sequence of Secret resources. |
ListSecretsAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListSecretsResponse, Secret> ListSecretsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [Secrets][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. The resource name of the project associated with the
[Secrets][google.cloud.secretmanager.v1.Secret], in the format |
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListSecretsResponse, Secret> |
A pageable asynchronous sequence of Secret resources. |
ListSecretVersions(ListSecretVersionsRequest, CallSettings)
public virtual PagedEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersions(ListSecretVersionsRequest request, CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secretmanager.v1.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 |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedEnumerable<ListSecretVersionsResponse, SecretVersion> |
A pageable sequence of SecretVersion resources. |
ListSecretVersions(SecretName, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersions(SecretName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
| Parameters | |
|---|---|
| Name | Description |
parent |
SecretNameRequired. 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
|
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedEnumerable<ListSecretVersionsResponse, SecretVersion> |
A pageable sequence of SecretVersion resources. |
ListSecretVersions(String, String, Nullable<Int32>, CallSettings)
public virtual PagedEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersions(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. 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
|
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedEnumerable<ListSecretVersionsResponse, SecretVersion> |
A pageable sequence of SecretVersion resources. |
ListSecretVersionsAsync(ListSecretVersionsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersionsAsync(ListSecretVersionsRequest request, CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secretmanager.v1.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 |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> |
A pageable asynchronous sequence of SecretVersion resources. |
ListSecretVersionsAsync(SecretName, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersionsAsync(SecretName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
| Parameters | |
|---|---|
| Name | Description |
parent |
SecretNameRequired. 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
|
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> |
A pageable asynchronous sequence of SecretVersion resources. |
ListSecretVersionsAsync(String, String, Nullable<Int32>, CallSettings)
public virtual PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> ListSecretVersionsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)Lists [SecretVersions][google.cloud.secretmanager.v1.SecretVersion]. This call does not return secret data.
| Parameters | |
|---|---|
| Name | Description |
parent |
System.StringRequired. 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
|
pageToken |
System.StringThe token returned from the previous request. A value of |
pageSize |
System.Nullable<System.Int32>The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Api.Gax.PagedAsyncEnumerable<ListSecretVersionsResponse, SecretVersion> |
A pageable asynchronous sequence of SecretVersion resources. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public virtual 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.secretmanager.v1.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
Google.Cloud.Iam.V1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Cloud.Iam.V1.Policy |
The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public virtual 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.secretmanager.v1.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
Google.Cloud.Iam.V1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> |
A Task containing the RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)
public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CancellationToken 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 |
Google.Cloud.Iam.V1.SetIamPolicyRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.Policy> |
A Task containing the RPC response. |
ShutdownDefaultChannelsAsync()
public static Task ShutdownDefaultChannelsAsync()Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task |
A task representing the asynchronous shutdown operation. |
After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public virtual 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 |
Google.Cloud.Iam.V1.TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Google.Cloud.Iam.V1.TestIamPermissionsResponse |
The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public virtual 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 |
Google.Cloud.Iam.V1.TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> |
A Task containing the RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)
public virtual Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CancellationToken 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 |
Google.Cloud.Iam.V1.TestIamPermissionsRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> |
A Task containing the RPC response. |
UpdateSecret(Secret, FieldMask, CallSettings)
public virtual Secret UpdateSecret(Secret secret, FieldMask updateMask, CallSettings callSettings = null)Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
secret |
SecretRequired. [Secret][google.cloud.secretmanager.v1.Secret] with updated field values. |
updateMask |
Google.Protobuf.WellKnownTypes.FieldMaskRequired. Specifies the fields to be updated. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
UpdateSecret(UpdateSecretRequest, CallSettings)
public virtual Secret UpdateSecret(UpdateSecretRequest request, CallSettings callSettings = null)Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Secret |
The RPC response. |
UpdateSecretAsync(Secret, FieldMask, CallSettings)
public virtual Task<Secret> UpdateSecretAsync(Secret secret, FieldMask updateMask, CallSettings callSettings = null)Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
secret |
SecretRequired. [Secret][google.cloud.secretmanager.v1.Secret] with updated field values. |
updateMask |
Google.Protobuf.WellKnownTypes.FieldMaskRequired. Specifies the fields to be updated. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
UpdateSecretAsync(Secret, FieldMask, CancellationToken)
public virtual Task<Secret> UpdateSecretAsync(Secret secret, FieldMask updateMask, CancellationToken cancellationToken)Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
secret |
SecretRequired. [Secret][google.cloud.secretmanager.v1.Secret] with updated field values. |
updateMask |
Google.Protobuf.WellKnownTypes.FieldMaskRequired. Specifies the fields to be updated. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
UpdateSecretAsync(UpdateSecretRequest, CallSettings)
public virtual Task<Secret> UpdateSecretAsync(UpdateSecretRequest request, CallSettings callSettings = null)Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSecretRequestThe request object containing all of the parameters for the API call. |
callSettings |
Google.Api.Gax.Grpc.CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |
UpdateSecretAsync(UpdateSecretRequest, CancellationToken)
public virtual Task<Secret> UpdateSecretAsync(UpdateSecretRequest request, CancellationToken cancellationToken)Updates metadata of an existing [Secret][google.cloud.secretmanager.v1.Secret].
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateSecretRequestThe request object containing all of the parameters for the API call. |
cancellationToken |
System.Threading.CancellationTokenA System.Threading.CancellationToken to use for this RPC. |
| Returns | |
|---|---|
| Type | Description |
System.Threading.Tasks.Task<Secret> |
A Task containing the RPC response. |