API Keys v2 API - Class Key (1.2.0)

public sealed class Key : IMessage<Key>, IEquatable<Key>, IDeepCloneable<Key>, IBufferMessage, IMessage

Reference documentation and code samples for the API Keys v2 API class Key.

The representation of a key managed by the API Keys API.

Inheritance

object > Key

Namespace

Google.Cloud.ApiKeys.V2

Assembly

Google.Cloud.ApiKeys.V2.dll

Constructors

Key()

public Key()

Key(Key)

public Key(Key other)
Parameter
NameDescription
otherKey

Properties

Annotations

public MapField<string, string> Annotations { get; }

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.

Property Value
TypeDescription
MapFieldstringstring

CreateTime

public Timestamp CreateTime { get; set; }

Output only. A timestamp identifying the time this key was originally created.

Property Value
TypeDescription
Timestamp

DeleteTime

public Timestamp DeleteTime { get; set; }

Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.

Property Value
TypeDescription
Timestamp

DisplayName

public string DisplayName { get; set; }

Human-readable display name of this key that you can modify. The maximum length is 63 characters.

Property Value
TypeDescription
string

Etag

public string Etag { get; set; }

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.

Property Value
TypeDescription
string

KeyName

public KeyName KeyName { get; set; }

KeyName-typed view over the Name resource name property.

Property Value
TypeDescription
KeyName

KeyString

public string KeyString { get; set; }

Output only. An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.

Property Value
TypeDescription
string

Name

public string Name { get; set; }

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.

Property Value
TypeDescription
string

Restrictions

public Restrictions Restrictions { get; set; }

Key restrictions.

Property Value
TypeDescription
Restrictions

Uid

public string Uid { get; set; }

Output only. Unique id in UUID4 format.

Property Value
TypeDescription
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. A timestamp identifying the time this key was last updated.

Property Value
TypeDescription
Timestamp