Reference documentation and code samples for the Google Cloud Api Keys V2 Client class CreateKeyRequest.
Request message for CreateKey
method.
Generated from protobuf message google.api.apikeys.v2.CreateKeyRequest
Namespace
Google \ Cloud \ ApiKeys \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The project in which the API key is created.
↳ key
Key
Required. The API key fields to set at creation time. You can configure only the display_name
, restrictions
, and annotations
fields.
↳ key_id
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.
getParent
Required. The project in which the API key is created.
string
setParent
Required. The project in which the API key is created.
var
string
$this
getKey
Required. The API key fields to set at creation time.
You can configure only the display_name
, restrictions
, and annotations
fields.
hasKey
clearKey
setKey
Required. The API key fields to set at creation time.
You can configure only the display_name
, restrictions
, and annotations
fields.
$this
getKeyId
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.
string
setKeyId
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.
var
string
$this
static::build
parent
string
Required. The project in which the API key is created. Please see ApiKeysClient::locationName() for help formatting this field.
key
Key
Required. The API key fields to set at creation time.
You can configure only the display_name
, restrictions
, and annotations
fields.
keyId
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.
