- 0.49.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.2
public interface KeyOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsAnnotations(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnnotations() (deprecated)
public abstract Map<String,String> getAnnotations()Use #getAnnotationsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsCount()
public abstract 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 abstract 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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationsOrDefault(String key, String defaultValue)
public abstract 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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getAnnotationsOrThrow(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
String |
|
getCreateTime()
public abstract 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 abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDeleteTime()
public abstract 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 abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayName()
public abstract 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 abstract 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()
public abstract String 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 abstract 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 abstract 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 abstract 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()
public abstract String 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 abstract 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. |
getRestrictions()
public abstract Restrictions getRestrictions()Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
| Returns | |
|---|---|
| Type | Description |
Restrictions |
The restrictions. |
getRestrictionsOrBuilder()
public abstract RestrictionsOrBuilder getRestrictionsOrBuilder()Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
| Returns | |
|---|---|
| Type | Description |
RestrictionsOrBuilder |
|
getUid()
public abstract String 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 abstract 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. |
getUpdateTime()
public abstract 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 abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public abstract 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 abstract 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 abstract boolean hasRestrictions()Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the restrictions field is set. |
hasUpdateTime()
public abstract 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. |