Module google_secretmanager1::api[][src]

Structs

AccessSecretVersionResponse

Response message for SecretManagerService.AccessSecretVersion.

AddSecretVersionRequest

Request message for SecretManagerService.AddSecretVersion.

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { “audit_configs”: [ { “service”: “allServices”, “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” }, { “log_type”: “ADMIN_READ” } ] }, { “service”: “sampleservice.googleapis.com”, “audit_log_configs”: [ { “log_type”: “DATA_READ” }, { “log_type”: “DATA_WRITE”, “exempted_members”: [ “user:aliya@example.com” ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { “audit_log_configs”: [ { “log_type”: “DATA_READ”, “exempted_members”: [ “user:jose@example.com” ] }, { “log_type”: “DATA_WRITE” } ] } This enables ‘DATA_READ’ and ‘DATA_WRITE’ logging, while exempting jose@example.com from DATA_READ logging.

Automatic

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

AutomaticStatus

The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy.

Binding

Associates members with a role.

CustomerManagedEncryption

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

CustomerManagedEncryptionStatus

Describes the status of customer-managed encryption.

DestroySecretVersionRequest

Request message for SecretManagerService.DestroySecretVersion.

DisableSecretVersionRequest

Request message for SecretManagerService.DisableSecretVersion.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

EnableSecretVersionRequest

Request message for SecretManagerService.EnableSecretVersion.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: “Summary size limit” description: “Determines if a summary is less than 100 chars” expression: “document.summary.size() < 100” Example (Equality): title: “Requestor is owner” description: “Determines if requestor is the document owner” expression: “document.owner == request.auth.claims.email” Example (Logic): title: “Public documents” description: “Determine whether the document should be publicly visible” expression: “document.type != ‘private’ && document.type != ‘internal’” Example (Data Manipulation): title: “Notification string” description: “Create a notification string with a timestamp.” expression: “’New message received at ’ + string(document.create_time)” The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

ListLocationsResponse

The response message for Locations.ListLocations.

ListSecretVersionsResponse

Response message for SecretManagerService.ListSecretVersions.

ListSecretsResponse

Response message for SecretManagerService.ListSecrets.

Location

A resource that represents Google Cloud Platform location.

Policy

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 to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; 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. 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.

ProjectLocationGetCall

Gets information about a location.

ProjectLocationListCall

Lists information about the supported locations for this service.

ProjectMethods

A builder providing access to all methods supported on project resources. It is not used directly, but through the SecretManager hub.

ProjectSecretAddVersionCall

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

ProjectSecretCreateCall

Creates a new Secret containing no SecretVersions.

ProjectSecretDeleteCall

Deletes a Secret.

ProjectSecretGetCall

Gets metadata for a given Secret.

ProjectSecretGetIamPolicyCall

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

ProjectSecretListCall

Lists Secrets.

ProjectSecretPatchCall

Updates metadata of an existing Secret.

ProjectSecretSetIamPolicyCall

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

ProjectSecretTestIamPermissionCall

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.

ProjectSecretVersionAccesCall

Accesses a SecretVersion. This call returns the secret data. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

ProjectSecretVersionDestroyCall

Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

ProjectSecretVersionDisableCall

Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.

ProjectSecretVersionEnableCall

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

ProjectSecretVersionGetCall

Gets metadata for a SecretVersion. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

ProjectSecretVersionListCall

Lists SecretVersions. This call does not return secret data.

Replica

Represents a Replica for this Secret.

ReplicaStatus

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

Replication

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

ReplicationStatus

The replication status of a 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.

SecretManager

Central instance to access all SecretManager related resource activities

SecretPayload

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

SecretVersion

A secret version resource in the Secret Manager API.

SetIamPolicyRequest

Request message for SetIamPolicy method.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

Topic

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

UserManaged

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

UserManagedStatus

The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy.

Enums

Scope

Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.