- 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 static final class Key.Builder extends GeneratedMessageV3.Builder<Key.Builder> implements KeyOrBuilder
The representation of a key managed by the API Keys API.
Protobuf type google.api.apikeys.v2.Key
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Key.BuilderImplements
KeyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Key.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Key.Builder |
build()
public Key build()
Returns | |
---|---|
Type | Description |
Key |
buildPartial()
public Key buildPartial()
Returns | |
---|---|
Type | Description |
Key |
clear()
public Key.Builder clear()
Returns | |
---|---|
Type | Description |
Key.Builder |
clearAnnotations()
public Key.Builder clearAnnotations()
Returns | |
---|---|
Type | Description |
Key.Builder |
clearCreateTime()
public Key.Builder clearCreateTime()
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 |
Key.Builder |
clearDeleteTime()
public Key.Builder clearDeleteTime()
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 |
Key.Builder |
clearDisplayName()
public Key.Builder clearDisplayName()
Human-readable display name of this key that you can modify. The maximum length is 63 characters.
string display_name = 2;
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
clearEtag()
public Key.Builder clearEtag()
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 |
Key.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Key.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Key.Builder |
clearKeyString()
public Key.Builder clearKeyString()
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 |
Key.Builder | This builder for chaining. |
clearName()
public Key.Builder clearName()
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 |
Key.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Key.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Key.Builder |
clearRestrictions()
public Key.Builder clearRestrictions()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Returns | |
---|---|
Type | Description |
Key.Builder |
clearUid()
public Key.Builder clearUid()
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
clearUpdateTime()
public Key.Builder clearUpdateTime()
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 |
Key.Builder |
clone()
public Key.Builder clone()
Returns | |
---|---|
Type | Description |
Key.Builder |
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 |
Returns | |
---|---|
Type | Description |
boolean |
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()
Use #getAnnotationsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
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;
Returns | |
---|---|
Type | Description |
Map<String,String> |
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;
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
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 |
Returns | |
---|---|
Type | Description |
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
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 |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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. |
getDeleteTimeBuilder()
public Timestamp.Builder getDeleteTimeBuilder()
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 |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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()
public 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 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. |
getMutableAnnotations() (deprecated)
public Map<String,String> getMutableAnnotations()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public 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 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 Restrictions getRestrictions()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Returns | |
---|---|
Type | Description |
Restrictions | The restrictions. |
getRestrictionsBuilder()
public Restrictions.Builder getRestrictionsBuilder()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Returns | |
---|---|
Type | Description |
Restrictions.Builder |
getRestrictionsOrBuilder()
public RestrictionsOrBuilder getRestrictionsOrBuilder()
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Returns | |
---|---|
Type | Description |
RestrictionsOrBuilder |
getUid()
public 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 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 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
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 |
Builder |
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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public Key.Builder mergeCreateTime(Timestamp value)
Output only. A timestamp identifying the time this key was originally created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Key.Builder |
mergeDeleteTime(Timestamp value)
public Key.Builder mergeDeleteTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Key.Builder |
mergeFrom(Key other)
public Key.Builder mergeFrom(Key other)
Parameter | |
---|---|
Name | Description |
other | Key |
Returns | |
---|---|
Type | Description |
Key.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Key.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Key.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Key.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Key.Builder |
mergeRestrictions(Restrictions value)
public Key.Builder mergeRestrictions(Restrictions value)
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Parameter | |
---|---|
Name | Description |
value | Restrictions |
Returns | |
---|---|
Type | Description |
Key.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Key.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Key.Builder |
mergeUpdateTime(Timestamp value)
public Key.Builder mergeUpdateTime(Timestamp value)
Output only. A timestamp identifying the time this key was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Key.Builder |
putAllAnnotations(Map<String,String> values)
public Key.Builder putAllAnnotations(Map<String,String> values)
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 |
values | Map<String,String> |
Returns | |
---|---|
Type | Description |
Key.Builder |
putAnnotations(String key, String value)
public Key.Builder putAnnotations(String key, String value)
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 |
value | String |
Returns | |
---|---|
Type | Description |
Key.Builder |
removeAnnotations(String key)
public Key.Builder removeAnnotations(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 |
Key.Builder |
setCreateTime(Timestamp value)
public Key.Builder setCreateTime(Timestamp value)
Output only. A timestamp identifying the time this key was originally created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Key.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Key.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. A timestamp identifying the time this key was originally created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Key.Builder |
setDeleteTime(Timestamp value)
public Key.Builder setDeleteTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Key.Builder |
setDeleteTime(Timestamp.Builder builderForValue)
public Key.Builder setDeleteTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Key.Builder |
setDisplayName(String value)
public Key.Builder setDisplayName(String value)
Human-readable display name of this key that you can modify. The maximum length is 63 characters.
string display_name = 2;
Parameter | |
---|---|
Name | Description |
value | String The displayName to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Key.Builder setDisplayNameBytes(ByteString value)
Human-readable display name of this key that you can modify. The maximum length is 63 characters.
string display_name = 2;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setEtag(String value)
public Key.Builder setEtag(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The etag to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setEtagBytes(ByteString value)
public Key.Builder setEtagBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for etag to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Key.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Key.Builder |
setKeyString(String value)
public Key.Builder setKeyString(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The keyString to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setKeyStringBytes(ByteString value)
public Key.Builder setKeyStringBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for keyString to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setName(String value)
public Key.Builder setName(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Key.Builder setNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Key.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Key.Builder |
setRestrictions(Restrictions value)
public Key.Builder setRestrictions(Restrictions value)
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Parameter | |
---|---|
Name | Description |
value | Restrictions |
Returns | |
---|---|
Type | Description |
Key.Builder |
setRestrictions(Restrictions.Builder builderForValue)
public Key.Builder setRestrictions(Restrictions.Builder builderForValue)
Key restrictions.
.google.api.apikeys.v2.Restrictions restrictions = 9;
Parameter | |
---|---|
Name | Description |
builderForValue | Restrictions.Builder |
Returns | |
---|---|
Type | Description |
Key.Builder |
setUid(String value)
public Key.Builder setUid(String value)
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The uid to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setUidBytes(ByteString value)
public Key.Builder setUidBytes(ByteString value)
Output only. Unique id in UUID4 format.
string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for uid to set. |
Returns | |
---|---|
Type | Description |
Key.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Key.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Key.Builder |
setUpdateTime(Timestamp value)
public Key.Builder setUpdateTime(Timestamp value)
Output only. A timestamp identifying the time this key was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Key.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public Key.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. A timestamp identifying the time this key was last updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Key.Builder |