SecretManagerServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.secretmanager_v1beta1.services.secret_manager_service.transports.base.SecretManagerServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-secret-manager/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
Inheritance
builtins.object > SecretManagerServiceAsyncClientProperties
transport
Return the transport used by the client instance.
Type | Description |
SecretManagerServiceTransport | The transport used by the client instance. |
Methods
SecretManagerServiceAsyncClient
SecretManagerServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.secretmanager_v1beta1.services.secret_manager_service.transports.base.SecretManagerServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-secret-manager/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiate the secret manager service client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.SecretManagerServiceTransport`]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
access_secret_version
access_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.AccessSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Accesses a xref_SecretVersion. This call returns the secret data.
projects/*/secrets/*/versions/latest
is an alias to the
latest
xref_SecretVersion.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.AccessSecretVersionRequest, dict]
The request object. Request message for SecretManagerService.AccessSecretVersion. |
name |
`str`
Required. The resource name of the SecretVersion in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.AccessSecretVersionResponse | Response message for SecretManagerService.AccessSecretVersion. |
add_secret_version
add_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.AddSecretVersionRequest, dict]] = None, *, parent: Optional[str] = None, payload: Optional[google.cloud.secretmanager_v1beta1.types.resources.SecretPayload] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new xref_SecretVersion containing secret data and attaches it to an existing xref_Secret.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.AddSecretVersionRequest, dict]
The request object. Request message for SecretManagerService.AddSecretVersion. |
parent |
`str`
Required. The resource name of the Secret to associate with the SecretVersion in the format |
payload |
SecretPayload
Required. The secret payload of the SecretVersion. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.SecretVersion | A secret version resource in the Secret Manager API. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Return a fully-qualified project string.
create_secret
create_secret(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.CreateSecretRequest, dict]] = None, *, parent: Optional[str] = None, secret_id: Optional[str] = None, secret: Optional[google.cloud.secretmanager_v1beta1.types.resources.Secret] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new xref_Secret containing no xref_SecretVersions.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.CreateSecretRequest, dict]
The request object. Request message for SecretManagerService.CreateSecret. |
parent |
`str`
Required. The resource name of the project to associate with the Secret, in the format |
secret_id |
`str`
Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen ( |
secret |
Secret
Required. A Secret with initial field values. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.Secret | A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data. |
delete_secret
delete_secret(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.DeleteSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a xref_Secret.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.DeleteSecretRequest, dict]
The request object. Request message for SecretManagerService.DeleteSecret. |
name |
`str`
Required. The resource name of the Secret to delete in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
destroy_secret_version
destroy_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.DestroySecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Destroys a xref_SecretVersion.
Sets the xref_state of the xref_SecretVersion to xref_DESTROYED and irrevocably destroys the secret data.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.DestroySecretVersionRequest, dict]
The request object. Request message for SecretManagerService.DestroySecretVersion. |
name |
`str`
Required. The resource name of the SecretVersion to destroy in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.SecretVersion | A secret version resource in the Secret Manager API. |
disable_secret_version
disable_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.DisableSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Disables a xref_SecretVersion.
Sets the xref_state of the xref_SecretVersion to xref_DISABLED.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.DisableSecretVersionRequest, dict]
The request object. Request message for SecretManagerService.DisableSecretVersion. |
name |
`str`
Required. The resource name of the SecretVersion to disable in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.SecretVersion | A secret version resource in the Secret Manager API. |
enable_secret_version
enable_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.EnableSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Enables a xref_SecretVersion.
Sets the xref_state of the xref_SecretVersion to xref_ENABLED.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.EnableSecretVersionRequest, dict]
The request object. Request message for SecretManagerService.EnableSecretVersion. |
name |
`str`
Required. The resource name of the SecretVersion to enable in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.SecretVersion | A secret version resource in the Secret Manager API. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
SecretManagerServiceAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
SecretManagerServiceAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
SecretManagerServiceAsyncClient | The constructed client. |
get_iam_policy
get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.iam.v1.policy_pb2.Policy | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" developer's="" guide](\=""> |
get_secret
get_secret(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.GetSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets metadata for a given xref_Secret.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.GetSecretRequest, dict]
The request object. Request message for SecretManagerService.GetSecret. |
name |
`str`
Required. The resource name of the Secret, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.Secret | A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data. |
get_secret_version
get_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.GetSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets metadata for a xref_SecretVersion.
projects/*/secrets/*/versions/latest
is an alias to the
latest
xref_SecretVersion.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.GetSecretVersionRequest, dict]
The request object. Request message for SecretManagerService.GetSecretVersion. |
name |
`str`
Required. The resource name of the SecretVersion in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.SecretVersion | A secret version resource in the Secret Manager API. |
get_transport_class
get_transport_class()
Return an appropriate transport class.
list_secret_versions
list_secret_versions(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.ListSecretVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_SecretVersions. This call does not return secret data.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.ListSecretVersionsRequest, dict]
The request object. Request message for SecretManagerService.ListSecretVersions. |
parent |
`str`
Required. The resource name of the Secret associated with the SecretVersions to list, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.services.secret_manager_service.pagers.ListSecretVersionsAsyncPager | Response message for SecretManagerService.ListSecretVersions. Iterating over this object will yield results and resolve additional pages automatically. |
list_secrets
list_secrets(request: Optional[Union[google.cloud.secretmanager_v1beta1.types.service.ListSecretsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists xref_Secrets.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.ListSecretsRequest, dict]
The request object. Request message for SecretManagerService.ListSecrets. |
parent |
`str`
Required. The resource name of the project associated with the Secrets, in the format |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.services.secret_manager_service.pagers.ListSecretsAsyncPager | Response message for SecretManagerService.ListSecrets. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_secret_path
parse_secret_path(path: str)
Parse a secret path into its component segments.
parse_secret_version_path
parse_secret_version_path(path: str)
Parse a secret_version path into its component segments.
secret_path
secret_path(project: str, secret: str)
Return a fully-qualified secret string.
secret_version_path
secret_version_path(project: str, secret: str, secret_version: str)
Return a fully-qualified secret_version string.
set_iam_policy
set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the access control policy on the specified secret. Replaces any existing policy.
Permissions on xref_SecretVersions are enforced according to the policy set on the associated xref_Secret.
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.iam.v1.policy_pb2.Policy | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" developer's="" guide](\=""> |
test_iam_permissions
test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse | Response message for TestIamPermissions method. |
update_secret
update_secret(request: Optional[google.cloud.secretmanager_v1beta1.types.service.UpdateSecretRequest] = None, *, secret: Optional[google.cloud.secretmanager_v1beta1.types.resources.Secret] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates metadata of an existing xref_Secret.
Name | Description |
request |
Union[google.cloud.secretmanager_v1beta1.types.UpdateSecretRequest, dict]
The request object. Request message for SecretManagerService.UpdateSecret. |
secret |
Secret
Required. Secret with updated field values. This corresponds to the |
update_mask |
`google.protobuf.field_mask_pb2.FieldMask`
Required. Specifies the fields to be updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.secretmanager_v1beta1.types.Secret | A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data. |