Class RetiredResource.Builder (2.88.0)

public static final class RetiredResource.Builder extends GeneratedMessage.Builder<RetiredResource.Builder> implements RetiredResourceOrBuilder

A RetiredResource resource represents the record of a deleted CryptoKey. Its purpose is to provide visibility into retained user data and to prevent reuse of these names for new CryptoKeys.

Protobuf type google.cloud.kms.v1.RetiredResource

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public RetiredResource build()
Returns
Type Description
RetiredResource

buildPartial()

public RetiredResource buildPartial()
Returns
Type Description
RetiredResource

clear()

public RetiredResource.Builder clear()
Returns
Type Description
RetiredResource.Builder
Overrides

clearDeleteTime()

public RetiredResource.Builder clearDeleteTime()

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RetiredResource.Builder

clearName()

public RetiredResource.Builder clearName()

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

clearOriginalResource()

public RetiredResource.Builder clearOriginalResource()

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string original_resource = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

clearResourceType()

public RetiredResource.Builder clearResourceType()

Output only. The resource type of the original deleted resource.

string resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

getDefaultInstanceForType()

public RetiredResource getDefaultInstanceForType()
Returns
Type Description
RetiredResource

getDeleteTime()

public Timestamp getDeleteTime()

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getName()

public String getName()

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getOriginalResource()

public String getOriginalResource()

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string original_resource = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The originalResource.

getOriginalResourceBytes()

public ByteString getOriginalResourceBytes()

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string original_resource = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for originalResource.

getResourceType()

public String getResourceType()

Output only. The resource type of the original deleted resource.

string resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The resourceType.

getResourceTypeBytes()

public ByteString getResourceTypeBytes()

Output only. The resource type of the original deleted resource.

string resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for resourceType.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDeleteTime(Timestamp value)

public RetiredResource.Builder mergeDeleteTime(Timestamp value)

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
RetiredResource.Builder

mergeFrom(RetiredResource other)

public RetiredResource.Builder mergeFrom(RetiredResource other)
Parameter
Name Description
other RetiredResource
Returns
Type Description
RetiredResource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RetiredResource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RetiredResource.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RetiredResource.Builder
Overrides

setDeleteTime(Timestamp value)

public RetiredResource.Builder setDeleteTime(Timestamp value)

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
RetiredResource.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public RetiredResource.Builder setDeleteTime(Timestamp.Builder builderForValue)

Output only. The time at which the original resource was deleted and this RetiredResource record was created.

.google.protobuf.Timestamp delete_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RetiredResource.Builder

setName(String value)

public RetiredResource.Builder setName(String value)

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RetiredResource.Builder setNameBytes(ByteString value)

Output only. Identifier. The resource name for this RetiredResource in the format projects/*/locations/*/retiredResources/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

setOriginalResource(String value)

public RetiredResource.Builder setOriginalResource(String value)

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string original_resource = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The originalResource to set.

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

setOriginalResourceBytes(ByteString value)

public RetiredResource.Builder setOriginalResourceBytes(ByteString value)

Output only. The full resource name of the original CryptoKey that was deleted in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

string original_resource = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for originalResource to set.

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

setResourceType(String value)

public RetiredResource.Builder setResourceType(String value)

Output only. The resource type of the original deleted resource.

string resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The resourceType to set.

Returns
Type Description
RetiredResource.Builder

This builder for chaining.

setResourceTypeBytes(ByteString value)

public RetiredResource.Builder setResourceTypeBytes(ByteString value)

Output only. The resource type of the original deleted resource.

string resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for resourceType to set.

Returns
Type Description
RetiredResource.Builder

This builder for chaining.