Package com.google.api.apikeys.v2
Class Key
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.api.apikeys.v2.Key
- All Implemented Interfaces:
KeyOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Key
extends com.google.protobuf.GeneratedMessage
implements KeyOrBuilder
The representation of a key managed by the API Keys API.Protobuf type
google.api.apikeys.v2.Key- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classThe representation of a key managed by the API Keys API.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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanAnnotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.booleanDeprecated.intAnnotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.getAnnotationsOrDefault(String key, String defaultValue) Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static Keycom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static final com.google.protobuf.Descriptors.DescriptorHuman-readable display name of this key that you can modify.com.google.protobuf.ByteStringHuman-readable display name of this key that you can modify.getEtag()Output only.com.google.protobuf.ByteStringOutput only.Output only.com.google.protobuf.ByteStringOutput only.getName()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.Parser<Key>Key restrictions.Key restrictions.intgetUid()Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOutput only.inthashCode()booleanKey restrictions.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Key.Builderstatic Key.BuildernewBuilder(Key prototype) protected Key.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static KeyparseDelimitedFrom(InputStream input) static KeyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyparseFrom(byte[] data) static KeyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyparseFrom(com.google.protobuf.ByteString data) static KeyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyparseFrom(com.google.protobuf.CodedInputStream input) static KeyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyparseFrom(InputStream input) static KeyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyparseFrom(ByteBuffer data) static KeyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Key>parser()voidwriteTo(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, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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:
-
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
KEY_STRING_FIELD_NUMBER
public static final int KEY_STRING_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER- See Also:
-
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER- See Also:
-
RESTRICTIONS_FIELD_NUMBER
public static final int RESTRICTIONS_FIELD_NUMBER- See Also:
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Output only. The resource name of the key. The `name` has the form: `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNamein interfaceKeyOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Output only. The resource name of the key. The `name` has the form: `projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getNameBytesin interfaceKeyOrBuilder- Returns:
- The bytes for name.
-
getUid
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUidin interfaceKeyOrBuilder- Returns:
- The uid.
-
getUidBytes
public com.google.protobuf.ByteString getUidBytes()Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUidBytesin interfaceKeyOrBuilder- Returns:
- The bytes for uid.
-
getDisplayName
Human-readable display name of this key that you can modify. The maximum length is 63 characters.
string display_name = 2;- Specified by:
getDisplayNamein interfaceKeyOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()Human-readable display name of this key that you can modify. The maximum length is 63 characters.
string display_name = 2;- Specified by:
getDisplayNameBytesin interfaceKeyOrBuilder- Returns:
- The bytes for displayName.
-
getKeyString
Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.
string key_string = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getKeyStringin interfaceKeyOrBuilder- Returns:
- The keyString.
-
getKeyStringBytes
public com.google.protobuf.ByteString getKeyStringBytes()Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.
string key_string = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getKeyStringBytesin interfaceKeyOrBuilder- Returns:
- The bytes for keyString.
-
hasCreateTime
public boolean hasCreateTime()Output only. A timestamp identifying the time this key was originally created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceKeyOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. A timestamp identifying the time this key was originally created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceKeyOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. A timestamp identifying the time this key was originally created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceKeyOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. A timestamp identifying the time this key was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceKeyOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. A timestamp identifying the time this key was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceKeyOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. A timestamp identifying the time this key was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceKeyOrBuilder
-
hasDeleteTime
public boolean hasDeleteTime()Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasDeleteTimein interfaceKeyOrBuilder- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
public com.google.protobuf.Timestamp getDeleteTime()Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeleteTimein interfaceKeyOrBuilder- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.
.google.protobuf.Timestamp delete_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeleteTimeOrBuilderin interfaceKeyOrBuilder
-
getAnnotationsCount
public int getAnnotationsCount()Description copied from interface:KeyOrBuilderAnnotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
map<string, string> annotations = 8;- Specified by:
getAnnotationsCountin interfaceKeyOrBuilder
-
containsAnnotations
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
map<string, string> annotations = 8;- Specified by:
containsAnnotationsin interfaceKeyOrBuilder
-
getAnnotations
Deprecated.UsegetAnnotationsMap()instead.- Specified by:
getAnnotationsin interfaceKeyOrBuilder
-
getAnnotationsMap
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
map<string, string> annotations = 8;- Specified by:
getAnnotationsMapin interfaceKeyOrBuilder
-
getAnnotationsOrDefault
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
map<string, string> annotations = 8;- Specified by:
getAnnotationsOrDefaultin interfaceKeyOrBuilder
-
getAnnotationsOrThrow
Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
map<string, string> annotations = 8;- Specified by:
getAnnotationsOrThrowin interfaceKeyOrBuilder
-
hasRestrictions
public boolean hasRestrictions()Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;- Specified by:
hasRestrictionsin interfaceKeyOrBuilder- Returns:
- Whether the restrictions field is set.
-
getRestrictions
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;- Specified by:
getRestrictionsin interfaceKeyOrBuilder- Returns:
- The restrictions.
-
getRestrictionsOrBuilder
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;- Specified by:
getRestrictionsOrBuilderin interfaceKeyOrBuilder
-
getEtag
Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEtagin interfaceKeyOrBuilder- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.ByteString getEtagBytes()Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.
string etag = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getEtagBytesin interfaceKeyOrBuilder- Returns:
- The bytes for etag.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Key parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Key parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Key parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Key parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Key parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Key parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Key parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Key parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
- Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-