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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KEY_STRING_FIELD_NUMBER
public static final int KEY_STRING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RESTRICTIONS_FIELD_NUMBER
public static final int RESTRICTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Key getDefaultInstance()
| Returns |
|---|
| Type | Description |
Key | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Key.Builder newBuilder()
newBuilder(Key prototype)
public static Key.Builder newBuilder(Key prototype)
| Parameter |
|---|
| Name | Description |
prototype | Key
|
public static Key parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(byte[] data)
public static Key parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteString data)
public static Key parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Key | |
public static Key parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteBuffer data)
public static Key parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Key | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Key parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Key | |
parser()
public static Parser<Key> parser()
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;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
| Parameter |
|---|
| Name | Description |
key | String
|
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];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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 |
|---|
| Type | Description |
Key | |
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];
| Returns |
|---|
| Type | Description |
Timestamp | The deleteTime.
|
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for etag.
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for keyString.
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Key> getParserForType()
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 |
|---|
| Type | Description |
int | |
Overrides
getUid()
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the deleteTime field is set.
|
hasRestrictions()
public boolean hasRestrictions()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Key.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Key.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Key.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
