As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

SecretManagerService¶

class google.cloud.secretmanager_v1beta2.services.secret_manager_service.SecretManagerServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport, typing.Callable[[...], google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

[Secret][google.cloud.secretmanager.v1beta2.Secret]
[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]

Instantiates the secret manager service async client.

Parameters

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 (Optional[Union[str,SecretManagerServiceTransport,Callable[..., SecretManagerServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the SecretManagerServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async access_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.AccessSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.service.AccessSecretVersionResponse[source]¶

Accesses a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. This call returns the secret data.

projects/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_access_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.AccessSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.access_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.AccessSecretVersionRequest, dict]]) – The request object. Request message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.AccessSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

projects/*/secrets/*/versions/latest or projects/*/locations/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

Response message for: [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.AccessSecretVersion].

Return type

google.cloud.secretmanager_v1beta2.types.AccessSecretVersionResponse

async add_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.AddSecretVersionRequest, dict]] = None, *, parent: Optional[str] = None, payload: Optional[google.cloud.secretmanager_v1beta2.types.resources.SecretPayload] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Creates a new [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_add_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.AddSecretVersionRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.add_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.AddSecretVersionRequest, dict]]) – The request object. Request message for [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.AddSecretVersion].
parent (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] to associate with the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] in the format projects/*/secrets/* or projects/*/locations/*/secrets/*.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
payload (google.cloud.secretmanager_v1beta2.types.SecretPayload) –
Required. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

This corresponds to the payload field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.CreateSecretRequest, dict]] = None, *, parent: Optional[str] = None, secret_id: Optional[str] = None, secret: Optional[google.cloud.secretmanager_v1beta2.types.resources.Secret] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.Secret[source]¶

Creates a new [Secret][google.cloud.secretmanager.v1beta2.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_create_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.CreateSecretRequest(
        parent="parent_value",
        secret_id="secret_id_value",
    )

    # Make the request
    response = await client.create_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.CreateSecretRequest, dict]]) – The request object. Request message for [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.CreateSecret].
parent (str) –
Required. The resource name of the project to associate with the [Secret][google.cloud.secretmanager.v1beta2.Secret], in the format projects/* or projects/*/locations/*.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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 (-) and underscore (_) characters.

This corresponds to the secret_id field on the request instance; if request is provided, this should not be set.
secret (google.cloud.secretmanager_v1beta2.types.Secret) –
Required. A [Secret][google.cloud.secretmanager.v1beta2.Secret] with initial field values.

This corresponds to the secret field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret

whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Return type

google.cloud.secretmanager_v1beta2.types.Secret

async delete_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.DeleteSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_delete_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.DeleteSecretRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_secret(request=request)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.DeleteSecretRequest, dict]]) – The request object. Request message for [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.DeleteSecret].
name (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] to delete in the format projects/*/secrets/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

async destroy_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.DestroySecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Destroys a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to [DESTROYED][google.cloud.secretmanager.v1beta2.SecretVersion.State.DESTROYED] and irrevocably destroys the secret data.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_destroy_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.DestroySecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.destroy_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.DestroySecretVersionRequest, dict]]) – The request object. Request message for [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.DestroySecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to destroy in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

async disable_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.DisableSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Disables a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to [DISABLED][google.cloud.secretmanager.v1beta2.SecretVersion.State.DISABLED].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_disable_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.DisableSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.disable_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.DisableSecretVersionRequest, dict]]) – The request object. Request message for [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.DisableSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to disable in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

async enable_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.EnableSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Enables a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to [ENABLED][google.cloud.secretmanager.v1beta2.SecretVersion.State.ENABLED].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_enable_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.EnableSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.enable_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.EnableSecretVersionRequest, dict]]) – The request object. Request message for [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.EnableSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to enable in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SecretManagerServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SecretManagerServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SecretManagerServiceAsyncClient

async get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_get_iam_policy():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]]) – The request object. Request message for GetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`

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') etag: BwWWja0YfJA= version: 3`

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.GetSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.Secret[source]¶

Gets metadata for a given [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_get_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.GetSecretRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.GetSecretRequest, dict]]) – The request object. Request message for [SecretManagerService.GetSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.GetSecret].
name (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret], in the format projects/*/secrets/* or projects/*/locations/*/secrets/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret

whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Return type

google.cloud.secretmanager_v1beta2.types.Secret

async get_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.GetSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

projects/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_get_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.GetSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.GetSecretVersionRequest, dict]]) – The request object. Request message for [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.GetSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

projects/*/secrets/*/versions/latest or projects/*/locations/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_secret_versions(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretVersionsAsyncPager[source]¶

Lists [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion]. This call does not return secret data.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_list_secret_versions():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.ListSecretVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_secret_versions(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.ListSecretVersionsRequest, dict]]) – The request object. Request message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecretVersions].
parent (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] associated with the [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] to list, in the format projects/*/secrets/* or projects/*/locations/*/secrets/*.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

Response message for: [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecretVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretVersionsAsyncPager

async list_secrets(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.ListSecretsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretsAsyncPager[source]¶

Lists [Secrets][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_list_secrets():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.ListSecretsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_secrets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.ListSecretsRequest, dict]]) – The request object. Request message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecrets].
parent (str) –
Required. The resource name of the project associated with the [Secrets][google.cloud.secretmanager.v1beta2.Secret], in the format projects/* or projects/*/locations/*

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

Response message for: [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecrets].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretsAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_secret_path(path: str) → Dict[str, str]¶: Parses a secret path into its component segments.

static parse_secret_version_path(path: str) → Dict[str, str]¶: Parses a secret_version path into its component segments.

static parse_topic_path(path: str) → Dict[str, str]¶: Parses a topic path into its component segments.

static secret_path(project: str, secret: str) → str¶: Returns a fully-qualified secret string.

static secret_version_path(project: str, secret: str, secret_version: str) → str¶: Returns a fully-qualified secret_version string.

async set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Sets the access control policy on the specified secret. Replaces any existing policy.

Permissions on [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_set_iam_policy():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = await client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]]) – The request object. Request message for SetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`

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') etag: BwWWja0YfJA= version: 3`

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

async test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

async def sample_test_iam_permissions():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = await client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]]) – The request object. Request message for TestIamPermissions method.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

static topic_path(project: str, topic: str) → str¶: Returns a fully-qualified topic string.

property transport: google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: SecretManagerServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.UpdateSecretRequest, dict]] = None, *, secret: Optional[google.cloud.secretmanager_v1beta2.types.resources.Secret] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.Secret[source]¶

Updates metadata of an existing [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

async def sample_update_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceAsyncClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.UpdateSecretRequest(
    )

    # Make the request
    response = await client.update_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.secretmanager_v1beta2.types.UpdateSecretRequest, dict]]) – The request object. Request message for [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.UpdateSecret].
secret (google.cloud.secretmanager_v1beta2.types.Secret) –
Required. [Secret][google.cloud.secretmanager.v1beta2.Secret] with updated field values.

This corresponds to the secret field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Specifies the fields to be updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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.

Returns

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret

whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Return type

google.cloud.secretmanager_v1beta2.types.Secret

class google.cloud.secretmanager_v1beta2.services.secret_manager_service.SecretManagerServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport, typing.Callable[[...], google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

Secret Manager Service

Manages secrets and operations using those secrets. Implements a REST model with the following objects:

[Secret][google.cloud.secretmanager.v1beta2.Secret]
[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]

Instantiates the secret manager service client.

Parameters

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 (Optional[Union[str,SecretManagerServiceTransport,Callable[..., SecretManagerServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the SecretManagerServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

access_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.AccessSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.service.AccessSecretVersionResponse[source]¶

Accesses a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. This call returns the secret data.

projects/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_access_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.AccessSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.access_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.AccessSecretVersionRequest, dict]) – The request object. Request message for [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.AccessSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

projects/*/secrets/*/versions/latest or projects/*/locations/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

Returns

Response message for: [SecretManagerService.AccessSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.AccessSecretVersion].

Return type

google.cloud.secretmanager_v1beta2.types.AccessSecretVersionResponse

add_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.AddSecretVersionRequest, dict]] = None, *, parent: Optional[str] = None, payload: Optional[google.cloud.secretmanager_v1beta2.types.resources.SecretPayload] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Creates a new [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] containing secret data and attaches it to an existing [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_add_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.AddSecretVersionRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.add_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.AddSecretVersionRequest, dict]) – The request object. Request message for [SecretManagerService.AddSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.AddSecretVersion].
parent (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] to associate with the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] in the format projects/*/secrets/* or projects/*/locations/*/secrets/*.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
payload (google.cloud.secretmanager_v1beta2.types.SecretPayload) –
Required. The secret payload of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

This corresponds to the payload field on the request instance; if request is provided, this should not be set.
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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.CreateSecretRequest, dict]] = None, *, parent: Optional[str] = None, secret_id: Optional[str] = None, secret: Optional[google.cloud.secretmanager_v1beta2.types.resources.Secret] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.Secret[source]¶

Creates a new [Secret][google.cloud.secretmanager.v1beta2.Secret] containing no [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_create_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.CreateSecretRequest(
        parent="parent_value",
        secret_id="secret_id_value",
    )

    # Make the request
    response = client.create_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.CreateSecretRequest, dict]) – The request object. Request message for [SecretManagerService.CreateSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.CreateSecret].
parent (str) –
Required. The resource name of the project to associate with the [Secret][google.cloud.secretmanager.v1beta2.Secret], in the format projects/* or projects/*/locations/*.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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 (-) and underscore (_) characters.

This corresponds to the secret_id field on the request instance; if request is provided, this should not be set.
secret (google.cloud.secretmanager_v1beta2.types.Secret) –
Required. A [Secret][google.cloud.secretmanager.v1beta2.Secret] with initial field values.

This corresponds to the secret field on the request instance; if request is provided, this should not be set.
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.

Returns

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret

whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Return type

google.cloud.secretmanager_v1beta2.types.Secret

delete_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.DeleteSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes a [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_delete_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.DeleteSecretRequest(
        name="name_value",
    )

    # Make the request
    client.delete_secret(request=request)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.DeleteSecretRequest, dict]) – The request object. Request message for [SecretManagerService.DeleteSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.DeleteSecret].
name (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] to delete in the format projects/*/secrets/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.DestroySecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Destroys a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to [DESTROYED][google.cloud.secretmanager.v1beta2.SecretVersion.State.DESTROYED] and irrevocably destroys the secret data.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_destroy_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.DestroySecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.destroy_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.DestroySecretVersionRequest, dict]) – The request object. Request message for [SecretManagerService.DestroySecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.DestroySecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to destroy in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

disable_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.DisableSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Disables a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to [DISABLED][google.cloud.secretmanager.v1beta2.SecretVersion.State.DISABLED].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_disable_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.DisableSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.disable_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.DisableSecretVersionRequest, dict]) – The request object. Request message for [SecretManagerService.DisableSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.DisableSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to disable in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

enable_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.EnableSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Enables a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

Sets the [state][google.cloud.secretmanager.v1beta2.SecretVersion.state] of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to [ENABLED][google.cloud.secretmanager.v1beta2.SecretVersion.State.ENABLED].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_enable_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.EnableSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.enable_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.EnableSecretVersionRequest, dict]) – The request object. Request message for [SecretManagerService.EnableSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.EnableSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] to enable in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SecretManagerServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SecretManagerServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SecretManagerServiceClient

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.
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.

Returns

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`

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') etag: BwWWja0YfJA= version: 3`

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
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.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.GetSecretRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.Secret[source]¶

Gets metadata for a given [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_get_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.GetSecretRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.GetSecretRequest, dict]) – The request object. Request message for [SecretManagerService.GetSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.GetSecret].
name (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret], in the format projects/*/secrets/* or projects/*/locations/*/secrets/*.

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

Returns

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret

whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Return type

google.cloud.secretmanager_v1beta2.types.Secret

get_secret_version(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.GetSecretVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.SecretVersion[source]¶

Gets metadata for a [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

projects/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_get_secret_version():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.GetSecretVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_secret_version(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.GetSecretVersionRequest, dict]) – The request object. Request message for [SecretManagerService.GetSecretVersion][google.cloud.secretmanager.v1beta2.SecretManagerService.GetSecretVersion].
name (str) –
Required. The resource name of the [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion] in the format projects/*/secrets/*/versions/* or projects/*/locations/*/secrets/*/versions/*.

projects/*/secrets/*/versions/latest or projects/*/locations/*/secrets/*/versions/latest is an alias to the most recently created [SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion].

This corresponds to the name field on the request instance; if request is provided, this should not be set.
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.

Returns

A secret version resource in the Secret Manager API.

Return type

google.cloud.secretmanager_v1beta2.types.SecretVersion

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
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.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

list_secret_versions(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretVersionsPager[source]¶

Lists [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion]. This call does not return secret data.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_list_secret_versions():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.ListSecretVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_secret_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.ListSecretVersionsRequest, dict]) – The request object. Request message for [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecretVersions].
parent (str) –
Required. The resource name of the [Secret][google.cloud.secretmanager.v1beta2.Secret] associated with the [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] to list, in the format projects/*/secrets/* or projects/*/locations/*/secrets/*.

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.

Returns

Response message for: [SecretManagerService.ListSecretVersions][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecretVersions].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretVersionsPager

list_secrets(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.ListSecretsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretsPager[source]¶

Lists [Secrets][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_list_secrets():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.ListSecretsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_secrets(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.ListSecretsRequest, dict]) – The request object. Request message for [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecrets].
parent (str) –
Required. The resource name of the project associated with the [Secrets][google.cloud.secretmanager.v1beta2.Secret], in the format projects/* or projects/*/locations/*

This corresponds to the parent field on the request instance; if request is provided, this should not be set.
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.

Returns

Response message for: [SecretManagerService.ListSecrets][google.cloud.secretmanager.v1beta2.SecretManagerService.ListSecrets].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretsPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_secret_path(path: str) → Dict[str, str][source]¶: Parses a secret path into its component segments.

static parse_secret_version_path(path: str) → Dict[str, str][source]¶: Parses a secret_version path into its component segments.

static parse_topic_path(path: str) → Dict[str, str][source]¶: Parses a topic path into its component segments.

static secret_path(project: str, secret: str) → str[source]¶: Returns a fully-qualified secret string.

static secret_version_path(project: str, secret: str, secret_version: str) → str[source]¶: Returns a fully-qualified secret_version string.

set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Sets the access control policy on the specified secret. Replaces any existing policy.

Permissions on [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] are enforced according to the policy set on the associated [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.
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.

Returns

An Identity and Access Management (IAM) policy, which specifies access

controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

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')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }`

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') etag: BwWWja0YfJA= version: 3`

For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Return type

google.iam.v1.policy_pb2.Policy

test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.
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.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

static topic_path(project: str, topic: str) → str[source]¶: Returns a fully-qualified topic string.

property transport: google.cloud.secretmanager_v1beta2.services.secret_manager_service.transports.base.SecretManagerServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

SecretManagerServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_secret(request: Optional[Union[google.cloud.secretmanager_v1beta2.types.service.UpdateSecretRequest, dict]] = None, *, secret: Optional[google.cloud.secretmanager_v1beta2.types.resources.Secret] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.secretmanager_v1beta2.types.resources.Secret[source]¶

Updates metadata of an existing [Secret][google.cloud.secretmanager.v1beta2.Secret].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import secretmanager_v1beta2

def sample_update_secret():
    # Create a client
    client = secretmanager_v1beta2.SecretManagerServiceClient()

    # Initialize request argument(s)
    request = secretmanager_v1beta2.UpdateSecretRequest(
    )

    # Make the request
    response = client.update_secret(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.secretmanager_v1beta2.types.UpdateSecretRequest, dict]) – The request object. Request message for [SecretManagerService.UpdateSecret][google.cloud.secretmanager.v1beta2.SecretManagerService.UpdateSecret].
secret (google.cloud.secretmanager_v1beta2.types.Secret) –
Required. [Secret][google.cloud.secretmanager.v1beta2.Secret] with updated field values.

This corresponds to the secret field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. Specifies the fields to be updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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.

Returns

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is a logical secret

whose value and versions can be accessed.

A [Secret][google.cloud.secretmanager.v1beta2.Secret] is made up of zero or more [SecretVersions][google.cloud.secretmanager.v1beta2.SecretVersion] that represent the secret data.

Return type

google.cloud.secretmanager_v1beta2.types.Secret

class google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretVersionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsResponse]], request: google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsRequest, response: google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial google.cloud.secretmanager_v1beta2.types.ListSecretVersionsResponse object, and provides an __aiter__ method to iterate through its versions field.

If there are more pages, the __aiter__ method will make additional ListSecretVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual google.cloud.secretmanager_v1beta2.types.ListSecretVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.secretmanager_v1beta2.types.ListSecretVersionsRequest) – The initial request object.
response (google.cloud.secretmanager_v1beta2.types.ListSecretVersionsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretVersionsPager(method: Callable[[...], google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsResponse], request: google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsRequest, response: google.cloud.secretmanager_v1beta2.types.service.ListSecretVersionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial google.cloud.secretmanager_v1beta2.types.ListSecretVersionsResponse object, and provides an __iter__ method to iterate through its versions field.

If there are more pages, the __iter__ method will make additional ListSecretVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual google.cloud.secretmanager_v1beta2.types.ListSecretVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.secretmanager_v1beta2.types.ListSecretVersionsRequest) – The initial request object.
response (google.cloud.secretmanager_v1beta2.types.ListSecretVersionsResponse) – The initial response object.
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.

class google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretsAsyncPager(method: Callable[[...], Awaitable[google.cloud.secretmanager_v1beta2.types.service.ListSecretsResponse]], request: google.cloud.secretmanager_v1beta2.types.service.ListSecretsRequest, response: google.cloud.secretmanager_v1beta2.types.service.ListSecretsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_secrets requests.

This class thinly wraps an initial google.cloud.secretmanager_v1beta2.types.ListSecretsResponse object, and provides an __aiter__ method to iterate through its secrets field.

If there are more pages, the __aiter__ method will make additional ListSecrets requests and continue to iterate through the secrets field on the corresponding responses.

All the usual google.cloud.secretmanager_v1beta2.types.ListSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.secretmanager_v1beta2.types.ListSecretsRequest) – The initial request object.
response (google.cloud.secretmanager_v1beta2.types.ListSecretsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.secretmanager_v1beta2.services.secret_manager_service.pagers.ListSecretsPager(method: Callable[[...], google.cloud.secretmanager_v1beta2.types.service.ListSecretsResponse], request: google.cloud.secretmanager_v1beta2.types.service.ListSecretsRequest, response: google.cloud.secretmanager_v1beta2.types.service.ListSecretsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_secrets requests.

This class thinly wraps an initial google.cloud.secretmanager_v1beta2.types.ListSecretsResponse object, and provides an __iter__ method to iterate through its secrets field.

If there are more pages, the __iter__ method will make additional ListSecrets requests and continue to iterate through the secrets field on the corresponding responses.

All the usual google.cloud.secretmanager_v1beta2.types.ListSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.secretmanager_v1beta2.types.ListSecretsRequest) – The initial request object.
response (google.cloud.secretmanager_v1beta2.types.ListSecretsResponse) – The initial response object.
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.

SecretManagerService¶

google-cloud-secret-manager

Navigation

Related Topics