Package com.google.cloud.kms.v1

Class KeyHandle

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.KeyHandle
All Implemented Interfaces:
KeyHandleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class KeyHandle extends com.google.protobuf.GeneratedMessage implements KeyHandleOrBuilder
 Resource-oriented representation of a request to Cloud KMS Autokey and the
 resulting provisioning of a [CryptoKey][google.cloud.kms.v1.CryptoKey].
Protobuf type google.cloud.kms.v1.KeyHandle
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeyHandle.Builder
    Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a [CryptoKey][google.cloud.kms.v1.CryptoKey].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    KMS_KEY_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESOURCE_TYPE_SELECTOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static KeyHandle
    getDefaultInstance()
     
    KeyHandle
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getKmsKey()
    Output only.
    com.google.protobuf.ByteString
    getKmsKeyBytes()
    Output only.
    String
    getName()
    Identifier.
    com.google.protobuf.ByteString
    getNameBytes()
    Identifier.
    com.google.protobuf.Parser<KeyHandle>
    getParserForType()
     
    String
    getResourceTypeSelector()
    Required.
    com.google.protobuf.ByteString
    getResourceTypeSelectorBytes()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeyHandle.Builder
    newBuilder()
     
    static KeyHandle.Builder
    newBuilder(KeyHandle prototype)
     
    KeyHandle.Builder
    newBuilderForType()
     
    protected KeyHandle.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static KeyHandle
    parseDelimitedFrom(InputStream input)
     
    static KeyHandle
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyHandle
    parseFrom(byte[] data)
     
    static KeyHandle
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyHandle
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeyHandle
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyHandle
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeyHandle
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyHandle
    parseFrom(InputStream input)
     
    static KeyHandle
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyHandle
    parseFrom(ByteBuffer data)
     
    static KeyHandle
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeyHandle>
    parser()
     
    KeyHandle.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • KMS_KEY_FIELD_NUMBER

      public static final int KMS_KEY_FIELD_NUMBER
      See Also:

    • RESOURCE_TYPE_SELECTOR_FIELD_NUMBER

      public static final int RESOURCE_TYPE_SELECTOR_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Identifier. Name of the [KeyHandle][google.cloud.kms.v1.KeyHandle]
 resource, e.g.
 `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface KeyHandleOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the [KeyHandle][google.cloud.kms.v1.KeyHandle]
 resource, e.g.
 `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface KeyHandleOrBuilder
      Returns:
      The bytes for name.

    • getKmsKey

      public String getKmsKey()
       Output only. Name of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that has
 been provisioned for Customer Managed Encryption Key (CMEK) use in the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] project and location for the
 requested resource type. The [CryptoKey][google.cloud.kms.v1.CryptoKey]
 project will reflect the value configured in the
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] on the resource
 project's ancestor folder at the time of the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] creation. If more than one
 ancestor folder has a configured
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig], the nearest of these
 configurations is used.
      string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKey in interface KeyHandleOrBuilder
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      public com.google.protobuf.ByteString getKmsKeyBytes()
       Output only. Name of a [CryptoKey][google.cloud.kms.v1.CryptoKey] that has
 been provisioned for Customer Managed Encryption Key (CMEK) use in the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] project and location for the
 requested resource type. The [CryptoKey][google.cloud.kms.v1.CryptoKey]
 project will reflect the value configured in the
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig] on the resource
 project's ancestor folder at the time of the
 [KeyHandle][google.cloud.kms.v1.KeyHandle] creation. If more than one
 ancestor folder has a configured
 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig], the nearest of these
 configurations is used.
      string kms_key = 3 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKmsKeyBytes in interface KeyHandleOrBuilder
      Returns:
      The bytes for kmsKey.

    • getResourceTypeSelector

      public String getResourceTypeSelector()
       Required. Indicates the resource type that the resulting
 [CryptoKey][google.cloud.kms.v1.CryptoKey] is meant to protect, e.g.
 `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource
 types.
      string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getResourceTypeSelector in interface KeyHandleOrBuilder
      Returns:
      The resourceTypeSelector.

    • getResourceTypeSelectorBytes

      public com.google.protobuf.ByteString getResourceTypeSelectorBytes()
       Required. Indicates the resource type that the resulting
 [CryptoKey][google.cloud.kms.v1.CryptoKey] is meant to protect, e.g.
 `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource
 types.
      string resource_type_selector = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getResourceTypeSelectorBytes in interface KeyHandleOrBuilder
      Returns:
      The bytes for resourceTypeSelector.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static KeyHandle parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeyHandle parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeyHandle parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeyHandle parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeyHandle parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeyHandle parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeyHandle parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeyHandle parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KeyHandle parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KeyHandle parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeyHandle parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeyHandle parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public KeyHandle.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static KeyHandle.Builder newBuilder()

    • newBuilder

      public static KeyHandle.Builder newBuilder(KeyHandle prototype)

    • toBuilder

      public KeyHandle.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected KeyHandle.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static KeyHandle getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<KeyHandle> parser()

    • getParserForType

      public com.google.protobuf.Parser<KeyHandle> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public KeyHandle getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder