Class: Google::Cloud::ApiKeys::V2::CreateKeyRequest

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

Overview

Request message for CreateKey method.

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ ::Google::Cloud::ApiKeys::V2::Key

Returns Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.

Returns:

  • (::Google::Cloud::ApiKeys::V2::Key) —

    Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.



44
45
46
47
 
# File 'proto_docs/google/api/apikeys/v2/apikeys.rb', line 44

class CreateKeyRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key_id ⇒ ::String

Returns User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

The id must NOT be a UUID-like string.

Returns:

  • (::String) —

    User specified key id (optional). If specified, it will become the final component of the key resource name.

    The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.

    The id must NOT be a UUID-like string.



44
45
46
47
 
# File 'proto_docs/google/api/apikeys/v2/apikeys.rb', line 44

class CreateKeyRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The project in which the API key is created.

Returns:

  • (::String) —

    Required. The project in which the API key is created.



44
45
46
47
 
# File 'proto_docs/google/api/apikeys/v2/apikeys.rb', line 44

class CreateKeyRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end