Summary of entries of Classes for secretmanager.
Classes
SecretManagerServiceAsyncClient
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
SecretManagerServiceClient
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
ListSecretVersionsAsyncPager
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.
ListSecretVersionsPager
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.
ListSecretsAsyncPager
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.
ListSecretsPager
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.
AccessSecretVersionRequest
Request message for SecretManagerService.AccessSecretVersion.
AccessSecretVersionResponse
Response message for SecretManagerService.AccessSecretVersion.
AddSecretVersionRequest
Request message for SecretManagerService.AddSecretVersion.
CreateSecretRequest
Request message for SecretManagerService.CreateSecret.
CustomerManagedEncryption
Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).
CustomerManagedEncryptionStatus
Describes the status of customer-managed encryption.
DeleteSecretRequest
Request message for SecretManagerService.DeleteSecret.
DestroySecretVersionRequest
Request message for SecretManagerService.DestroySecretVersion.
DisableSecretVersionRequest
Request message for SecretManagerService.DisableSecretVersion.
EnableSecretVersionRequest
Request message for SecretManagerService.EnableSecretVersion.
GetSecretRequest
Request message for SecretManagerService.GetSecret.
GetSecretVersionRequest
Request message for SecretManagerService.GetSecretVersion.
ListSecretVersionsRequest
Request message for SecretManagerService.ListSecretVersions.
ListSecretVersionsResponse
Response message for SecretManagerService.ListSecretVersions.
ListSecretsRequest
Request message for SecretManagerService.ListSecrets.
ListSecretsResponse
Response message for SecretManagerService.ListSecrets.
Replication
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
Automatic
A replication policy that replicates the Secret payload without any restrictions.
UserManaged
A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]
Replica
Represents a Replica for this Secret.
ReplicationStatus
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
AutomaticStatus
The replication status of a SecretVersion using automatic replication.
Only populated if the parent Secret has an automatic replication policy.
UserManagedStatus
The replication status of a SecretVersion using user-managed replication.
Only populated if the parent Secret has a user-managed replication policy.
ReplicaStatus
Describes the status of a user-managed replica for the SecretVersion.
Rotation
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.
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.
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
AnnotationsEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
VersionAliasesEntry
The abstract base class for a message.
SecretPayload
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
SecretVersion
A secret version resource in the Secret Manager API.
State
The state of a SecretVersion, indicating if it can be accessed.
Topic
A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.
UpdateSecretRequest
Request message for SecretManagerService.UpdateSecret.
SecretManagerServiceAsyncClient
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
SecretManagerServiceClient
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
ListSecretVersionsAsyncPager
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.
ListSecretVersionsPager
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.
ListSecretsAsyncPager
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.
ListSecretsPager
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.
AccessSecretVersionRequest
Request message for SecretManagerService.AccessSecretVersion.
AccessSecretVersionResponse
Response message for SecretManagerService.AccessSecretVersion.
AddSecretVersionRequest
Request message for SecretManagerService.AddSecretVersion.
CreateSecretRequest
Request message for SecretManagerService.CreateSecret.
DeleteSecretRequest
Request message for SecretManagerService.DeleteSecret.
DestroySecretVersionRequest
Request message for SecretManagerService.DestroySecretVersion.
DisableSecretVersionRequest
Request message for SecretManagerService.DisableSecretVersion.
EnableSecretVersionRequest
Request message for SecretManagerService.EnableSecretVersion.
GetSecretRequest
Request message for SecretManagerService.GetSecret.
GetSecretVersionRequest
Request message for SecretManagerService.GetSecretVersion.
ListSecretVersionsRequest
Request message for SecretManagerService.ListSecretVersions.
ListSecretVersionsResponse
Response message for SecretManagerService.ListSecretVersions.
ListSecretsRequest
Request message for SecretManagerService.ListSecrets.
ListSecretsResponse
Response message for SecretManagerService.ListSecrets.
Replication
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
Automatic
A replication policy that replicates the Secret payload without any restrictions.
UserManaged
A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]
Replica
Represents a Replica for this Secret.
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.
LabelsEntry
The abstract base class for a message.
SecretPayload
A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion.
SecretVersion
A secret version resource in the Secret Manager API.
State
The state of a SecretVersion, indicating if it can be accessed.
UpdateSecretRequest
Request message for SecretManagerService.UpdateSecret.
SecretManagerServiceAsyncClient
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
SecretManagerServiceClient
Secret Manager Service
Manages secrets and operations using those secrets. Implements a REST model with the following objects:
- Secret
- SecretVersion
ListSecretVersionsAsyncPager
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.
ListSecretVersionsPager
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.
ListSecretsAsyncPager
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.
ListSecretsPager
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.
AccessSecretVersionRequest
Request message for SecretManagerService.AccessSecretVersion.
AccessSecretVersionResponse
Response message for SecretManagerService.AccessSecretVersion.
AddSecretVersionRequest
Request message for SecretManagerService.AddSecretVersion.
CreateSecretRequest
Request message for SecretManagerService.CreateSecret.
CustomerManagedEncryption
Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).
CustomerManagedEncryptionStatus
Describes the status of customer-managed encryption.
DeleteSecretRequest
Request message for SecretManagerService.DeleteSecret.
DestroySecretVersionRequest
Request message for SecretManagerService.DestroySecretVersion.
DisableSecretVersionRequest
Request message for SecretManagerService.DisableSecretVersion.
EnableSecretVersionRequest
Request message for SecretManagerService.EnableSecretVersion.
GetSecretRequest
Request message for SecretManagerService.GetSecret.
GetSecretVersionRequest
Request message for SecretManagerService.GetSecretVersion.
ListSecretVersionsRequest
Request message for SecretManagerService.ListSecretVersions.
ListSecretVersionsResponse
Response message for SecretManagerService.ListSecretVersions.
ListSecretsRequest
Request message for SecretManagerService.ListSecrets.
ListSecretsResponse
Response message for SecretManagerService.ListSecrets.
Replication
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
Automatic
A replication policy that replicates the Secret payload without any restrictions.
UserManaged
A replication policy that replicates the Secret payload into the locations specified in [Secret.replication.user_managed.replicas][]
Replica
Represents a Replica for this Secret.
ReplicationStatus
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
AutomaticStatus
The replication status of a SecretVersion using automatic replication.
Only populated if the parent Secret has an automatic replication policy.
UserManagedStatus
The replication status of a SecretVersion using user-managed replication.
Only populated if the parent Secret has a user-managed replication policy.
ReplicaStatus
Describes the status of a user-managed replica for the SecretVersion.
Rotation
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.
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.
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
AnnotationsEntry
The abstract base class for a message.
LabelsEntry
The abstract base class for a message.
VersionAliasesEntry
The abstract base class for a message.
SecretPayload
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
SecretVersion
A secret version resource in the Secret Manager API.
State
The state of a SecretVersion, indicating if it can be accessed.
Topic
A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.
UpdateSecretRequest
Request message for SecretManagerService.UpdateSecret.
Modules
pagers
API documentation for secretmanager_v1.services.secret_manager_service.pagers module.
pagers
API documentation for secretmanager_v1beta1.services.secret_manager_service.pagers module.
pagers
API documentation for secretmanager_v1beta2.services.secret_manager_service.pagers module.