Interface CreateKeyRequestOrBuilder (0.31.0)

public interface CreateKeyRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getKey()

public abstract Key getKey()

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

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Key`	The key.

getKeyId()

public abstract String 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?.

The id must NOT be a UUID-like string.

string key_id = 3;

Returns
Type	Description
`String`	The keyId.

getKeyIdBytes()

public abstract ByteString getKeyIdBytes()

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

The id must NOT be a UUID-like string.

string key_id = 3;

Returns
Type	Description
`ByteString`	The bytes for keyId.

getKeyOrBuilder()

public abstract KeyOrBuilder getKeyOrBuilder()

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

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`KeyOrBuilder`

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

hasKey()

public abstract boolean hasKey()

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

.google.api.apikeys.v2.Key key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the key field is set.