Class RetiredResource (2.88.0)

public final class RetiredResource extends GeneratedMessage 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 Fields

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORIGINAL_RESOURCE_FIELD_NUMBER

public static final int ORIGINAL_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_TYPE_FIELD_NUMBER

public static final int RESOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RetiredResource getDefaultInstance()
Returns
Type Description
RetiredResource

getDescriptor()

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

newBuilder()

public static RetiredResource.Builder newBuilder()
Returns
Type Description
RetiredResource.Builder

newBuilder(RetiredResource prototype)

public static RetiredResource.Builder newBuilder(RetiredResource prototype)
Parameter
Name Description
prototype RetiredResource
Returns
Type Description
RetiredResource.Builder

parseDelimitedFrom(InputStream input)

public static RetiredResource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetiredResource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetiredResource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RetiredResource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RetiredResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RetiredResource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RetiredResource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RetiredResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RetiredResource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RetiredResource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RetiredResource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RetiredResource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RetiredResource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RetiredResource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RetiredResource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RetiredResource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RetiredResource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RetiredResource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RetiredResource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RetiredResource> parser()
Returns
Type Description
Parser<RetiredResource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

getParserForType()

public Parser<RetiredResource> getParserForType()
Returns
Type Description
Parser<RetiredResource>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RetiredResource.Builder newBuilderForType()
Returns
Type Description
RetiredResource.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RetiredResource.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RetiredResource.Builder
Overrides

toBuilder()

public RetiredResource.Builder toBuilder()
Returns
Type Description
RetiredResource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException