View Source GoogleApi.APIKeys.V2.Model.V2Key (google_api_api_keys v0.7.0)

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

Attributes

annotations (type: map(), default: nil) - 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.
createTime (type: DateTime.t, default: nil) - Output only. A timestamp identifying the time this key was originally created.
deleteTime (type: DateTime.t, default: nil) - Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
displayName (type: String.t, default: nil) - Human-readable display name of this key that you can modify. The maximum length is 63 characters.
etag (type: String.t, default: nil) - 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.
keyString (type: String.t, default: nil) - Output only. An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.
name (type: String.t, default: nil) - Output only. The resource name of the key. The name has the form: projects//locations/global/keys/. 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 (type: GoogleApi.APIKeys.V2.Model.V2Restrictions.t, default: nil) - Key restrictions.
serviceAccountEmail (type: String.t, default: nil) - Optional. The email address of the service account the key is bound to.
uid (type: String.t, default: nil) - Output only. Unique id in UUID4 format.
updateTime (type: DateTime.t, default: nil) - Output only. A timestamp identifying the time this key was last updated.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.APIKeys.V2.Model.V2Key{
  annotations: map() | nil,
  createTime: DateTime.t() | nil,
  deleteTime: DateTime.t() | nil,
  displayName: String.t() | nil,
  etag: String.t() | nil,
  keyString: String.t() | nil,
  name: String.t() | nil,
  restrictions: GoogleApi.APIKeys.V2.Model.V2Restrictions.t() | nil,
  serviceAccountEmail: String.t() | nil,
  uid: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.