Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: code documentation improvements #28116

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,9 @@ def logger
# Creates a new {::Google::Cloud::Kms::V1::KeyHandle KeyHandle}, triggering the
# provisioning of a new {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} for CMEK
# use with the given resource type in the configured key project and the same
# location. [GetOperation][Operations.GetOperation] should be used to resolve
# the resulting long-running operation and get the resulting
# {::Google::Cloud::Kms::V1::KeyHandle KeyHandle} and
# location. GetOperation should
# be used to resolve the resulting long-running operation and get the
# resulting {::Google::Cloud::Kms::V1::KeyHandle KeyHandle} and
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
#
# @overload create_key_handle(request, options = nil)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,9 +257,9 @@ def logger
# Creates a new {::Google::Cloud::Kms::V1::KeyHandle KeyHandle}, triggering the
# provisioning of a new {::Google::Cloud::Kms::V1::CryptoKey CryptoKey} for CMEK
# use with the given resource type in the configured key project and the same
# location. [GetOperation][Operations.GetOperation] should be used to resolve
# the resulting long-running operation and get the resulting
# {::Google::Cloud::Kms::V1::KeyHandle KeyHandle} and
# location. GetOperation should
# be used to resolve the resulting long-running operation and get the
# resulting {::Google::Cloud::Kms::V1::KeyHandle KeyHandle} and
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKey}.
#
# @overload create_key_handle(request, options = nil)
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -1585,7 +1585,9 @@ def create_crypto_key_version request, options = nil
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, the
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} must be a child of
# {::Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest#parent ImportCryptoKeyVersionRequest.parent},
# have been previously created via [ImportCryptoKeyVersion][], and be in
# have been previously created via
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#import_crypto_key_version ImportCryptoKeyVersion},
# and be in
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROYED DESTROYED}
# or
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::IMPORT_FAILED IMPORT_FAILED}
Expand Down Expand Up @@ -3340,7 +3342,8 @@ def mac_sign request, options = nil
# checksum. {::Google::Cloud::Kms::V1::KeyManagementService::Client KeyManagementService}
# will report an error if the checksum verification fails. If you receive a
# checksum error, your client should verify that
# CRC32C([MacVerifyRequest.tag][]) is equal to
# CRC32C({::Google::Cloud::Kms::V1::MacVerifyRequest#mac MacVerifyRequest.mac}) is
# equal to
# {::Google::Cloud::Kms::V1::MacVerifyRequest#mac_crc32c MacVerifyRequest.mac_crc32c},
# and if so, perform a limited number of retries. A persistent mismatch may
# indicate an issue in your computation of the CRC32C checksum. Note: This
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1496,7 +1496,9 @@ def create_crypto_key_version request, options = nil
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, the
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} must be a child of
# {::Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest#parent ImportCryptoKeyVersionRequest.parent},
# have been previously created via [ImportCryptoKeyVersion][], and be in
# have been previously created via
# {::Google::Cloud::Kms::V1::KeyManagementService::Rest::Client#import_crypto_key_version ImportCryptoKeyVersion},
# and be in
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROYED DESTROYED}
# or
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::IMPORT_FAILED IMPORT_FAILED}
Expand Down Expand Up @@ -3153,7 +3155,8 @@ def mac_sign request, options = nil
# checksum. {::Google::Cloud::Kms::V1::KeyManagementService::Rest::Client KeyManagementService}
# will report an error if the checksum verification fails. If you receive a
# checksum error, your client should verify that
# CRC32C([MacVerifyRequest.tag][]) is equal to
# CRC32C({::Google::Cloud::Kms::V1::MacVerifyRequest#mac MacVerifyRequest.mac}) is
# equal to
# {::Google::Cloud::Kms::V1::MacVerifyRequest#mac_crc32c MacVerifyRequest.mac_crc32c},
# and if so, perform a limited number of retries. A persistent mismatch may
# indicate an issue in your computation of the CRC32C checksum. Note: This
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ class Certificate
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} and
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} with a
# {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} of
# [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as well as
# {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL_VPC EXTERNAL_VPC}, as well as
# performing cryptographic operations using keys created within the
# {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}.
# @!attribute [r] name
Expand Down Expand Up @@ -286,6 +286,7 @@ module KeyManagementMode
# All {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} created with this
# {::Google::Cloud::Kms::V1::EkmConnection EkmConnection} use EKM-side key
# management operations initiated from Cloud KMS. This means that:
#
# * When a {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}
# associated with this {::Google::Cloud::Kms::V1::EkmConnection EkmConnection}
# is
Expand All @@ -294,7 +295,8 @@ module KeyManagementMode
# external key material.
# * Destruction of external key material associated with this
# {::Google::Cloud::Kms::V1::EkmConnection EkmConnection} can be requested by
# calling [DestroyCryptoKeyVersion][EkmService.DestroyCryptoKeyVersion].
# calling
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#destroy_crypto_key_version DestroyCryptoKeyVersion}.
# * Automatic rotation of key material is supported.
CLOUD_KMS = 2
end
Expand All @@ -305,7 +307,7 @@ module KeyManagementMode
# {::Google::Cloud::Kms::V1::CryptoKey CryptoKeys} and
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} with a
# {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} of
# [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a given
# {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL_VPC EXTERNAL_VPC} in a given
# project and location.
# @!attribute [r] name
# @return [::String]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ class KeyRing
# where all related cryptographic operations are performed. Only applicable
# if {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersions} have a
# {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevel} of
# [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the
# {::Google::Cloud::Kms::V1::ProtectionLevel::EXTERNAL_VPC EXTERNAL_VPC}, with the
# resource name in the format `projects/*/locations/*/ekmConnections/*`.
# Note, this list is non-exhaustive and may apply to additional
# {::Google::Cloud::Kms::V1::ProtectionLevel ProtectionLevels} in the future.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,9 @@ class CreateCryptoKeyVersionRequest
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}, the
# {::Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} must be a child of
# {::Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest#parent ImportCryptoKeyVersionRequest.parent},
# have been previously created via [ImportCryptoKeyVersion][], and be in
# have been previously created via
# {::Google::Cloud::Kms::V1::KeyManagementService::Client#import_crypto_key_version ImportCryptoKeyVersion},
# and be in
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::DESTROYED DESTROYED}
# or
# {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionState::IMPORT_FAILED IMPORT_FAILED}
Expand Down Expand Up @@ -1065,7 +1067,8 @@ class MacSignRequest
# checksum. {::Google::Cloud::Kms::V1::KeyManagementService::Client KeyManagementService}
# will report an error if the checksum verification fails. If you receive a
# checksum error, your client should verify that
# CRC32C([MacVerifyRequest.tag][]) is equal to
# CRC32C({::Google::Cloud::Kms::V1::MacVerifyRequest#mac MacVerifyRequest.mac}) is
# equal to
# {::Google::Cloud::Kms::V1::MacVerifyRequest#mac_crc32c MacVerifyRequest.mac_crc32c},
# and if so, perform a limited number of retries. A persistent mismatch may
# indicate an issue in your computation of the CRC32C checksum. Note: This
Expand Down
Loading