Class: Google::Apis::ApikeysV2::V2Key

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apikeys_v2/classes.rb,
lib/google/apis/apikeys_v2/representations.rb,
lib/google/apis/apikeys_v2/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ V2Key

Returns a new instance of V2Key.



345
346
347
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 345

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. A timestamp identifying the time this key was originally created. Corresponds to the JSON property createTime

Returns:

  • (String) 


294
295
296
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 294

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


300
301
302
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 300

def delete_time
  @delete_time
end

#display_name ⇒ String

Human-readable display name of this key that you can modify. The maximum length is 63 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


306
307
308
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 306

def display_name
  @display_name
end

#etag ⇒ 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. Corresponds to the JSON property etag

Returns:

  • (String) 


314
315
316
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 314

def etag
  @etag
end

#key_string ⇒ String

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

Returns:

  • (String) 


320
321
322
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 320

def key_string
  @key_string
end

#name ⇒ String

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. Corresponds to the JSON property name

Returns:

  • (String) 


328
329
330
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 328

def name
  @name
end

#restrictions ⇒ Google::Apis::ApikeysV2::V2Restrictions

Describes the restrictions on the key. Corresponds to the JSON property restrictions

Returns:



333
334
335
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 333

def restrictions
  @restrictions
end

#uid ⇒ String

Output only. Unique id in UUID4 format. Corresponds to the JSON property uid

Returns:

  • (String) 


338
339
340
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 338

def uid
  @uid
end

#update_time ⇒ String

Output only. A timestamp identifying the time this key was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


343
344
345
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 343

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/google/apis/apikeys_v2/classes.rb', line 350

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @key_string = args[:key_string] if args.key?(:key_string)
  @name = args[:name] if args.key?(:name)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end