Package com.google.api.apikeys.v2

Interface CreateKeyRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CreateKeyRequest, CreateKeyRequest.Builder
    public interface CreateKeyRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Key getKey()
      Required.
      String getKeyId()
      User specified key id (optional).
      com.google.protobuf.ByteString getKeyIdBytes()
      User specified key id (optional).
      KeyOrBuilder getKeyOrBuilder()
      Required.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      boolean hasKey()
      Required.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        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:
        The parent.

      • getParentBytes

        com.google.protobuf.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:
        The bytes for parent.

      • hasKey

        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:
        Whether the key field is set.

      • getKey

        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:
        The key.

      • getKeyOrBuilder

        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];

      • getKeyId

        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]([a-z0-9-]{0,61}[a-z0-9])?`.

 The id must NOT be a UUID-like string.
        string key_id = 3;
        Returns:
        The keyId.

      • getKeyIdBytes

        com.google.protobuf.ByteString getKeyIdBytes()
         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 key_id = 3;
        Returns:
        The bytes for keyId.