Class: Google::Cloud::ApiKeys::V2::Key

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/apikeys/v2/resources.rb

Overview

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

Defined Under Namespace

Classes: AnnotationsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns 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.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String (readonly)

Returns 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.

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.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#key_string ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns 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.

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.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#restrictions ⇒ ::Google::Cloud::ApiKeys::V2::Restrictions

Returns Key restrictions.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. Unique id in UUID4 format.

Returns:

  • (::String) —

    Output only. Unique id in UUID4 format.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'proto_docs/google/api/apikeys/v2/resources.rb', line 72

class Key
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end