Package com.google.cloud.kms.v1

Class AutokeyConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.kms.v1.AutokeyConfig
All Implemented Interfaces:
AutokeyConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AutokeyConfig extends com.google.protobuf.GeneratedMessage implements AutokeyConfigOrBuilder
 Cloud KMS Autokey configuration for a folder.
Protobuf type google.cloud.kms.v1.AutokeyConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AutokeyConfig.Builder
    Cloud KMS Autokey configuration for a folder.
    static enum 
    AutokeyConfig.KeyProjectResolutionMode
    Defines the resolution mode enum for the key project.
    static enum 
    AutokeyConfig.State
    The states AutokeyConfig can be in.

    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
    ETAG_FIELD_NUMBER
     
    static final int
    KEY_PROJECT_FIELD_NUMBER
     
    static final int
    KEY_PROJECT_RESOLUTION_MODE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    STATE_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 AutokeyConfig
    getDefaultInstance()
     
    AutokeyConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEtag()
    Optional.
    com.google.protobuf.ByteString
    getEtagBytes()
    Optional.
    String
    getKeyProject()
    Optional.
    com.google.protobuf.ByteString
    getKeyProjectBytes()
    Optional.
    AutokeyConfig.KeyProjectResolutionMode
    getKeyProjectResolutionMode()
    Optional.
    int
    getKeyProjectResolutionModeValue()
    Optional.
    String
    getName()
    Identifier.
    com.google.protobuf.ByteString
    getNameBytes()
    Identifier.
    com.google.protobuf.Parser<AutokeyConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    AutokeyConfig.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AutokeyConfig.Builder
    newBuilder()
     
    static AutokeyConfig.Builder
    newBuilder(AutokeyConfig prototype)
     
    AutokeyConfig.Builder
    newBuilderForType()
     
    protected AutokeyConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AutokeyConfig
    parseDelimitedFrom(InputStream input)
     
    static AutokeyConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutokeyConfig
    parseFrom(byte[] data)
     
    static AutokeyConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutokeyConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static AutokeyConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutokeyConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AutokeyConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutokeyConfig
    parseFrom(InputStream input)
     
    static AutokeyConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AutokeyConfig
    parseFrom(ByteBuffer data)
     
    static AutokeyConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AutokeyConfig>
    parser()
     
    AutokeyConfig.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:

    • KEY_PROJECT_FIELD_NUMBER

      public static final int KEY_PROJECT_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • ETAG_FIELD_NUMBER

      public static final int ETAG_FIELD_NUMBER
      See Also:

    • KEY_PROJECT_RESOLUTION_MODE_FIELD_NUMBER

      public static final int KEY_PROJECT_RESOLUTION_MODE_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 [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface AutokeyConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
 resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or
 `projects/{PROJECT_NUMBER}/autokeyConfig`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface AutokeyConfigOrBuilder
      Returns:
      The bytes for name.

    • getKeyProject

      public String getKeyProject()
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProject in interface AutokeyConfigOrBuilder
      Returns:
      The keyProject.

    • getKeyProjectBytes

      public com.google.protobuf.ByteString getKeyProjectBytes()
       Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or
 `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
 [CryptoKey][google.cloud.kms.v1.CryptoKey] when a
 [KeyHandle][google.cloud.kms.v1.KeyHandle] is created. On
 [UpdateAutokeyConfig][google.cloud.kms.v1.AutokeyAdmin.UpdateAutokeyConfig],
 the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on
 this key project. Once configured, for Cloud KMS Autokey to function
 properly, this key project must have the Cloud KMS API activated and the
 Cloud KMS Service Agent for this key project must be granted the
 `cloudkms.admin` role (or pertinent permissions). A request with an empty
 key project field will clear the configuration.
      string key_project = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProjectBytes in interface AutokeyConfigOrBuilder
      Returns:
      The bytes for keyProject.

    • getStateValue

      public int getStateValue()
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface AutokeyConfigOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public AutokeyConfig.State getState()
       Output only. The state for the AutokeyConfig.
      .google.cloud.kms.v1.AutokeyConfig.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface AutokeyConfigOrBuilder
      Returns:
      The state.

    • getEtag

      public String getEtag()
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtag in interface AutokeyConfigOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       Optional. A checksum computed by the server based on the value of other
 fields. This may be sent on update requests to ensure that the client has
 an up-to-date value before proceeding. The request will be rejected with an
 ABORTED error on a mismatched etag.
      string etag = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEtagBytes in interface AutokeyConfigOrBuilder
      Returns:
      The bytes for etag.

    • getKeyProjectResolutionModeValue

      public int getKeyProjectResolutionModeValue()
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProjectResolutionModeValue in interface AutokeyConfigOrBuilder
      Returns:
      The enum numeric value on the wire for keyProjectResolutionMode.

    • getKeyProjectResolutionMode

      public AutokeyConfig.KeyProjectResolutionMode getKeyProjectResolutionMode()
       Optional. KeyProjectResolutionMode for the AutokeyConfig.
 Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or
 `DISABLED`.
      .google.cloud.kms.v1.AutokeyConfig.KeyProjectResolutionMode key_project_resolution_mode = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getKeyProjectResolutionMode in interface AutokeyConfigOrBuilder
      Returns:
      The keyProjectResolutionMode.

    • 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 AutokeyConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AutokeyConfig.Builder newBuilder()

    • newBuilder

      public static AutokeyConfig.Builder newBuilder(AutokeyConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AutokeyConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<AutokeyConfig> 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 AutokeyConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder