Package Classes (2.20.0)

Secret Manager Service

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

• Secret
• SecretVersion

Secret Manager Service

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

• Secret
• SecretVersion

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secrets requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secrets requests.

This class thinly wraps an initial 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 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.

Request message for SecretManagerService.AccessSecretVersion.

Response message for SecretManagerService.AccessSecretVersion.

Request message for SecretManagerService.AddSecretVersion.

Request message for SecretManagerService.CreateSecret.

Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).

Describes the status of customer-managed encryption.

Request message for SecretManagerService.DeleteSecret.

Request message for SecretManagerService.DestroySecretVersion.

Request message for SecretManagerService.DisableSecretVersion.

Request message for SecretManagerService.EnableSecretVersion.

Request message for SecretManagerService.GetSecret.

Request message for SecretManagerService.GetSecretVersion.

Request message for SecretManagerService.ListSecretVersions.

Response message for SecretManagerService.ListSecretVersions.

Request message for SecretManagerService.ListSecrets.

Response message for SecretManagerService.ListSecrets.

A policy that defines the replication and encryption configuration of data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A replication policy that replicates the Secret payload without any restrictions.

A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]

Represents a Replica for this Secret.

The replication status of a SecretVersion.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The replication status of a SecretVersion using automatic replication.

Only populated if the parent Secret has an automatic replication policy.

The replication status of a SecretVersion using user-managed replication.

Only populated if the parent Secret has a user-managed replication policy.

Describes the status of a user-managed replica for the SecretVersion.

The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation.

A Secret is a logical secret whose value and versions can be accessed.

A Secret is made up of zero or more SecretVersions that represent the secret data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A secret version resource in the Secret Manager API.

The state of a SecretVersion, indicating if it can be accessed.

Values: STATE_UNSPECIFIED (0): Not specified. This value is unused and invalid. ENABLED (1): The SecretVersion may be accessed. DISABLED (2): The SecretVersion may not be accessed, but the secret data is still available and can be placed back into the ENABLED state. DESTROYED (3): The SecretVersion is destroyed and the secret data is no longer stored. A version may not leave this state once entered.

A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.

Request message for SecretManagerService.UpdateSecret.

Secret Manager Service

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

• Secret
• SecretVersion

Secret Manager Service

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

• Secret
• SecretVersion

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secrets requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secrets requests.

This class thinly wraps an initial 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 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.

Request message for SecretManagerService.AccessSecretVersion.

Response message for SecretManagerService.AccessSecretVersion.

Request message for SecretManagerService.AddSecretVersion.

Request message for SecretManagerService.CreateSecret.

Request message for SecretManagerService.DeleteSecret.

Request message for SecretManagerService.DestroySecretVersion.

Request message for SecretManagerService.DisableSecretVersion.

Request message for SecretManagerService.EnableSecretVersion.

Request message for SecretManagerService.GetSecret.

Request message for SecretManagerService.GetSecretVersion.

Request message for SecretManagerService.ListSecretVersions.

Response message for SecretManagerService.ListSecretVersions.

Request message for SecretManagerService.ListSecrets.

Response message for SecretManagerService.ListSecrets.

A policy that defines the replication configuration of data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A replication policy that replicates the Secret payload without any restrictions.

A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]

Represents a Replica for this Secret.

A Secret is a logical secret whose value and versions can be accessed.

A Secret is made up of zero or more SecretVersions that represent the secret data.

The abstract base class for a message.

A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion.

A secret version resource in the Secret Manager API.

The state of a SecretVersion, indicating if it can be accessed.

Values: STATE_UNSPECIFIED (0): Not specified. This value is unused and invalid. ENABLED (1): The SecretVersion may be accessed. DISABLED (2): The SecretVersion may not be accessed, but the secret data is still available and can be placed back into the ENABLED state. DESTROYED (3): The SecretVersion is destroyed and the secret data is no longer stored. A version may not leave this state once entered.

Request message for SecretManagerService.UpdateSecret.

Secret Manager Service

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

• Secret
• SecretVersion

Secret Manager Service

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

• Secret
• SecretVersion

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secret_versions requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secrets requests.

This class thinly wraps an initial 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 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.

A pager for iterating through list_secrets requests.

This class thinly wraps an initial 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 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.

Request message for SecretManagerService.AccessSecretVersion.

Response message for SecretManagerService.AccessSecretVersion.

Request message for SecretManagerService.AddSecretVersion.

Request message for SecretManagerService.CreateSecret.

Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).

Describes the status of customer-managed encryption.

Request message for SecretManagerService.DeleteSecret.

Request message for SecretManagerService.DestroySecretVersion.

Request message for SecretManagerService.DisableSecretVersion.

Request message for SecretManagerService.EnableSecretVersion.

Request message for SecretManagerService.GetSecret.

Request message for SecretManagerService.GetSecretVersion.

Request message for SecretManagerService.ListSecretVersions.

Response message for SecretManagerService.ListSecretVersions.

Request message for SecretManagerService.ListSecrets.

Response message for SecretManagerService.ListSecrets.

A policy that defines the replication and encryption configuration of data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A replication policy that replicates the Secret payload without any restrictions.

A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]

Represents a Replica for this Secret.

The replication status of a SecretVersion.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The replication status of a SecretVersion using automatic replication.

Only populated if the parent Secret has an automatic replication policy.

The replication status of a SecretVersion using user-managed replication.

Only populated if the parent Secret has a user-managed replication policy.

Describes the status of a user-managed replica for the SecretVersion.

The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation.

A Secret is a logical secret whose value and versions can be accessed.

A Secret is made up of zero or more SecretVersions that represent the secret data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A secret version resource in the Secret Manager API.

The state of a SecretVersion, indicating if it can be accessed.

Values: STATE_UNSPECIFIED (0): Not specified. This value is unused and invalid. ENABLED (1): The SecretVersion may be accessed. DISABLED (2): The SecretVersion may not be accessed, but the secret data is still available and can be placed back into the ENABLED state. DESTROYED (3): The SecretVersion is destroyed and the secret data is no longer stored. A version may not leave this state once entered.

A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.

Request message for SecretManagerService.UpdateSecret.

API documentation for secretmanager_v1.services.secret_manager_service.pagers module.

API documentation for secretmanager_v1beta1.services.secret_manager_service.pagers module.

API documentation for secretmanager_v1beta2.services.secret_manager_service.pagers module.