Reference documentation and code samples for the API Keys V2 API class Google::Cloud::ApiKeys::V2::Key.
The representation of a key managed by the API Keys API.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#annotations
def annotations() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
#annotations=
def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. A timestamp identifying the time this key was originally created.
#delete_time
def delete_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
#display_name
def display_name() -> ::String
Returns
- (::String) — Human-readable display name of this key that you can modify. The maximum length is 63 characters.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Human-readable display name of this key that you can modify. The maximum length is 63 characters.
Returns
- (::String) — Human-readable display name of this key that you can modify. The maximum length is 63 characters.
#etag
def etag() -> ::String
Returns
- (::String) — Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
#key_string
def key_string() -> ::String
Returns
-
(::String) — Output only. An encrypted and signed value held by this key.
This field can be accessed only through the
GetKeyString
method.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name of the key.
The
name
has the form:projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>
. For example:projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2
NOTE: Key is a global resource; hence the only supported value for location is
global
.
#restrictions
def restrictions() -> ::Google::Cloud::ApiKeys::V2::Restrictions
Returns
- (::Google::Cloud::ApiKeys::V2::Restrictions) — Key restrictions.
#restrictions=
def restrictions=(value) -> ::Google::Cloud::ApiKeys::V2::Restrictions
Parameter
- value (::Google::Cloud::ApiKeys::V2::Restrictions) — Key restrictions.
Returns
- (::Google::Cloud::ApiKeys::V2::Restrictions) — Key restrictions.
#uid
def uid() -> ::String
Returns
- (::String) — Output only. Unique id in UUID4 format.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. A timestamp identifying the time this key was last updated.