public final class Key extends GeneratedMessageV3 implements KeyOrBuilder
The representation of a key managed by the API Keys API.
Protobuf type google.api.apikeys.v2.Key
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
KEY_STRING_FIELD_NUMBER
public static final int KEY_STRING_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESTRICTIONS_FIELD_NUMBER
public static final int RESTRICTIONS_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Key getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Key.Builder newBuilder()
Returns
newBuilder(Key prototype)
public static Key.Builder newBuilder(Key prototype)
Parameter
| Name | Description |
| prototype | Key
|
Returns
public static Key parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Key parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Key parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Key parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Key parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Key parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Key parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Key parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Key parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Key> parser()
Returns
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
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;
getAnnotationsMap()
public Map<String,String> 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;
getAnnotationsOrDefault(String key, String defaultValue)
public String 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.
They are not queryable and should be preserved when modifying objects.
map<string, string> annotations = 8;
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
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;
getCreateTime()
public 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];
getCreateTimeOrBuilder()
public 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];
getDefaultInstanceForType()
public Key getDefaultInstanceForType()
Returns
getDeleteTime()
public 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];
getDeleteTimeOrBuilder()
public 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];
getDisplayName()
public String getDisplayName()
Human-readable display name of this key that you can modify.
The maximum length is 63 characters.
string display_name = 2;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Human-readable display name of this key that you can modify.
The maximum length is 63 characters.
string display_name = 2;
| Type | Description |
| ByteString | The bytes for displayName.
|
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];
| Type | Description |
| String | The etag.
|
getEtagBytes()
public 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];
getKeyString()
public String 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];
| Type | Description |
| String | The keyString.
|
getKeyStringBytes()
public 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];
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];
| Type | Description |
| String | The name.
|
getNameBytes()
public 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];
getParserForType()
public Parser<Key> getParserForType()
Returns
Overrides
getRestrictions()
public Restrictions getRestrictions()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
getRestrictionsOrBuilder()
public RestrictionsOrBuilder getRestrictionsOrBuilder()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUid()
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public ByteString getUidBytes()
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public 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];
getUpdateTimeOrBuilder()
public 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];
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];
| Type | Description |
| boolean | Whether the createTime field is set.
|
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];
| Type | Description |
| boolean | Whether the deleteTime field is set.
|
hasRestrictions()
public boolean hasRestrictions()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
| Type | Description |
| boolean | Whether the restrictions field is set.
|
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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Key.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Key.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Key.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
