mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-27 20:30:52 +01:00
84 lines
36 KiB
HTML
84 lines
36 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_cloudkms1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_cloudkms1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../google_cloudkms1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_cloudkms1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_cloudkms1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/google_cloudkms1/api.rs.html#1-11792" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
|
||
<table><tr class="module-item"><td><a class="struct" href="struct.AsymmetricDecryptRequest.html" title="google_cloudkms1::api::AsymmetricDecryptRequest struct">AsymmetricDecryptRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.AsymmetricDecrypt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AsymmetricDecryptResponse.html" title="google_cloudkms1::api::AsymmetricDecryptResponse struct">AsymmetricDecryptResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.AsymmetricDecrypt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AsymmetricSignRequest.html" title="google_cloudkms1::api::AsymmetricSignRequest struct">AsymmetricSignRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.AsymmetricSign.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AsymmetricSignResponse.html" title="google_cloudkms1::api::AsymmetricSignResponse struct">AsymmetricSignResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.AsymmetricSign.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditConfig.html" title="google_cloudkms1::api::AuditConfig struct">AuditConfig</a></td><td class="docblock-short"><p>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 <code>allServices</code> 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.AuditLogConfig.html" title="google_cloudkms1::api::AuditLogConfig struct">AuditLogConfig</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Binding.html" title="google_cloudkms1::api::Binding struct">Binding</a></td><td class="docblock-short"><p>Associates <code>members</code> with a <code>role</code>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CertificateChains.html" title="google_cloudkms1::api::CertificateChains struct">CertificateChains</a></td><td class="docblock-short"><p>Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CloudKMS.html" title="google_cloudkms1::api::CloudKMS struct">CloudKMS</a></td><td class="docblock-short"><p>Central instance to access all CloudKMS related resource activities</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CryptoKey.html" title="google_cloudkms1::api::CryptoKey struct">CryptoKey</a></td><td class="docblock-short"><p>A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CryptoKeyVersion.html" title="google_cloudkms1::api::CryptoKeyVersion struct">CryptoKeyVersion</a></td><td class="docblock-short"><p>A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CryptoKeyVersionTemplate.html" title="google_cloudkms1::api::CryptoKeyVersionTemplate struct">CryptoKeyVersionTemplate</a></td><td class="docblock-short"><p>A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DecryptRequest.html" title="google_cloudkms1::api::DecryptRequest struct">DecryptRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.Decrypt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DecryptResponse.html" title="google_cloudkms1::api::DecryptResponse struct">DecryptResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.Decrypt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DestroyCryptoKeyVersionRequest.html" title="google_cloudkms1::api::DestroyCryptoKeyVersionRequest struct">DestroyCryptoKeyVersionRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.DestroyCryptoKeyVersion.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Digest.html" title="google_cloudkms1::api::Digest struct">Digest</a></td><td class="docblock-short"><p>A Digest holds a cryptographic message digest.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EncryptRequest.html" title="google_cloudkms1::api::EncryptRequest struct">EncryptRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.Encrypt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EncryptResponse.html" title="google_cloudkms1::api::EncryptResponse struct">EncryptResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.Encrypt.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Expr.html" title="google_cloudkms1::api::Expr struct">Expr</a></td><td class="docblock-short"><p>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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ExternalProtectionLevelOptions.html" title="google_cloudkms1::api::ExternalProtectionLevelOptions struct">ExternalProtectionLevelOptions</a></td><td class="docblock-short"><p>ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ImportCryptoKeyVersionRequest.html" title="google_cloudkms1::api::ImportCryptoKeyVersionRequest struct">ImportCryptoKeyVersionRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.ImportCryptoKeyVersion.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ImportJob.html" title="google_cloudkms1::api::ImportJob struct">ImportJob</a></td><td class="docblock-short"><p>An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see <a href="https://cloud.google.com/kms/docs/importing-a-key">Importing a key</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.KeyOperationAttestation.html" title="google_cloudkms1::api::KeyOperationAttestation struct">KeyOperationAttestation</a></td><td class="docblock-short"><p>Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key).</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.KeyRing.html" title="google_cloudkms1::api::KeyRing struct">KeyRing</a></td><td class="docblock-short"><p>A KeyRing is a toplevel logical grouping of CryptoKeys.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListCryptoKeyVersionsResponse.html" title="google_cloudkms1::api::ListCryptoKeyVersionsResponse struct">ListCryptoKeyVersionsResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.ListCryptoKeyVersions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListCryptoKeysResponse.html" title="google_cloudkms1::api::ListCryptoKeysResponse struct">ListCryptoKeysResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.ListCryptoKeys.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListImportJobsResponse.html" title="google_cloudkms1::api::ListImportJobsResponse struct">ListImportJobsResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.ListImportJobs.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListKeyRingsResponse.html" title="google_cloudkms1::api::ListKeyRingsResponse struct">ListKeyRingsResponse</a></td><td class="docblock-short"><p>Response message for KeyManagementService.ListKeyRings.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListLocationsResponse.html" title="google_cloudkms1::api::ListLocationsResponse struct">ListLocationsResponse</a></td><td class="docblock-short"><p>The response message for Locations.ListLocations.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Location.html" title="google_cloudkms1::api::Location struct">Location</a></td><td class="docblock-short"><p>A resource that represents Google Cloud Platform location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Policy.html" title="google_cloudkms1::api::Policy struct">Policy</a></td><td class="docblock-short"><p>An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A <code>Policy</code> is a collection of <code>bindings</code>. A <code>binding</code> binds one or more <code>members</code> to a single <code>role</code>. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A <code>role</code> is a named list of permissions; each <code>role</code> can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a <code>binding</code> can also specify a <code>condition</code>, which is a logical expression that allows access to a resource only if the expression evaluates to <code>true</code>. 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 <a href="https://cloud.google.com/iam/help/conditions/resource-policies">IAM documentation</a>. <strong>JSON example:</strong> { "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 } <strong>YAML example:</strong> 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 <a href="https://cloud.google.com/iam/docs/">IAM documentation</a>.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationGetCall.html" title="google_cloudkms1::api::ProjectLocationGetCall struct">ProjectLocationGetCall</a></td><td class="docblock-short"><p>Gets information about a location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCreateCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCreateCall struct">ProjectLocationKeyRingCreateCall</a></td><td class="docblock-short"><p>Create a new KeyRing in a given Project and Location.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCreateCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCreateCall struct">ProjectLocationKeyRingCryptoKeyCreateCall</a></td><td class="docblock-short"><p>Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricDecryptCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricDecryptCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricDecryptCall</a></td><td class="docblock-short"><p>Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricSignCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricSignCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionAsymmetricSignCall</a></td><td class="docblock-short"><p>Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionCreateCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionCreateCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionCreateCall</a></td><td class="docblock-short"><p>Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionDestroyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionDestroyCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionDestroyCall</a></td><td class="docblock-short"><p>Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED and destroy_time will be set to a time 24 hours in the future, at which point the state will be changed to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetCall</a></td><td class="docblock-short"><p>Returns metadata for a given CryptoKeyVersion.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetPublicKeyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetPublicKeyCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionGetPublicKeyCall</a></td><td class="docblock-short"><p>Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionImportCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionImportCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionImportCall</a></td><td class="docblock-short"><p>Imports a new CryptoKeyVersion into an existing CryptoKey using the wrapped key material provided in the request. The version ID will be assigned the next sequential id within the CryptoKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionListCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionListCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionListCall</a></td><td class="docblock-short"><p>Lists CryptoKeyVersions.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionPatchCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionPatchCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionPatchCall</a></td><td class="docblock-short"><p>Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyCryptoKeyVersionRestoreCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyCryptoKeyVersionRestoreCall struct">ProjectLocationKeyRingCryptoKeyCryptoKeyVersionRestoreCall</a></td><td class="docblock-short"><p>Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyDecryptCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyDecryptCall struct">ProjectLocationKeyRingCryptoKeyDecryptCall</a></td><td class="docblock-short"><p>Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyEncryptCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyEncryptCall struct">ProjectLocationKeyRingCryptoKeyEncryptCall</a></td><td class="docblock-short"><p>Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyGetCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyGetCall struct">ProjectLocationKeyRingCryptoKeyGetCall</a></td><td class="docblock-short"><p>Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyGetIamPolicyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyGetIamPolicyCall struct">ProjectLocationKeyRingCryptoKeyGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyListCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyListCall struct">ProjectLocationKeyRingCryptoKeyListCall</a></td><td class="docblock-short"><p>Lists CryptoKeys.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyPatchCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyPatchCall struct">ProjectLocationKeyRingCryptoKeyPatchCall</a></td><td class="docblock-short"><p>Update a CryptoKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeySetIamPolicyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeySetIamPolicyCall struct">ProjectLocationKeyRingCryptoKeySetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyTestIamPermissionCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyTestIamPermissionCall struct">ProjectLocationKeyRingCryptoKeyTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingCryptoKeyUpdatePrimaryVersionCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingCryptoKeyUpdatePrimaryVersionCall struct">ProjectLocationKeyRingCryptoKeyUpdatePrimaryVersionCall</a></td><td class="docblock-short"><p>Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on an asymmetric key.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingGetCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingGetCall struct">ProjectLocationKeyRingGetCall</a></td><td class="docblock-short"><p>Returns metadata for a given KeyRing.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingGetIamPolicyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingGetIamPolicyCall struct">ProjectLocationKeyRingGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingImportJobCreateCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingImportJobCreateCall struct">ProjectLocationKeyRingImportJobCreateCall</a></td><td class="docblock-short"><p>Create a new ImportJob within a KeyRing. ImportJob.import_method is required.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingImportJobGetCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingImportJobGetCall struct">ProjectLocationKeyRingImportJobGetCall</a></td><td class="docblock-short"><p>Returns metadata for a given ImportJob.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingImportJobGetIamPolicyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingImportJobGetIamPolicyCall struct">ProjectLocationKeyRingImportJobGetIamPolicyCall</a></td><td class="docblock-short"><p>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingImportJobListCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingImportJobListCall struct">ProjectLocationKeyRingImportJobListCall</a></td><td class="docblock-short"><p>Lists ImportJobs.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingImportJobSetIamPolicyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingImportJobSetIamPolicyCall struct">ProjectLocationKeyRingImportJobSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingImportJobTestIamPermissionCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingImportJobTestIamPermissionCall struct">ProjectLocationKeyRingImportJobTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingListCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingListCall struct">ProjectLocationKeyRingListCall</a></td><td class="docblock-short"><p>Lists KeyRings.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingSetIamPolicyCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingSetIamPolicyCall struct">ProjectLocationKeyRingSetIamPolicyCall</a></td><td class="docblock-short"><p>Sets the access control policy on the specified resource. Replaces any existing policy. Can return <code>NOT_FOUND</code>, <code>INVALID_ARGUMENT</code>, and <code>PERMISSION_DENIED</code> errors.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationKeyRingTestIamPermissionCall.html" title="google_cloudkms1::api::ProjectLocationKeyRingTestIamPermissionCall struct">ProjectLocationKeyRingTestIamPermissionCall</a></td><td class="docblock-short"><p>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a <code>NOT_FOUND</code> 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.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectLocationListCall.html" title="google_cloudkms1::api::ProjectLocationListCall struct">ProjectLocationListCall</a></td><td class="docblock-short"><p>Lists information about the supported locations for this service.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_cloudkms1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
|
||
It is not used directly, but through the <code>CloudKMS</code> hub.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PublicKey.html" title="google_cloudkms1::api::PublicKey struct">PublicKey</a></td><td class="docblock-short"><p>The public key for a given CryptoKeyVersion. Obtained via GetPublicKey.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RestoreCryptoKeyVersionRequest.html" title="google_cloudkms1::api::RestoreCryptoKeyVersionRequest struct">RestoreCryptoKeyVersionRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.RestoreCryptoKeyVersion.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SetIamPolicyRequest.html" title="google_cloudkms1::api::SetIamPolicyRequest struct">SetIamPolicyRequest</a></td><td class="docblock-short"><p>Request message for <code>SetIamPolicy</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsRequest.html" title="google_cloudkms1::api::TestIamPermissionsRequest struct">TestIamPermissionsRequest</a></td><td class="docblock-short"><p>Request message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TestIamPermissionsResponse.html" title="google_cloudkms1::api::TestIamPermissionsResponse struct">TestIamPermissionsResponse</a></td><td class="docblock-short"><p>Response message for <code>TestIamPermissions</code> method.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UpdateCryptoKeyPrimaryVersionRequest.html" title="google_cloudkms1::api::UpdateCryptoKeyPrimaryVersionRequest struct">UpdateCryptoKeyPrimaryVersionRequest</a></td><td class="docblock-short"><p>Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WrappingPublicKey.html" title="google_cloudkms1::api::WrappingPublicKey struct">WrappingPublicKey</a></td><td class="docblock-short"><p>The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod.</p>
|
||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_cloudkms1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
|
||
A scope is needed when requesting an
|
||
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_cloudkms1"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |