Class KeyRing (2.18.0)

public final class KeyRing extends GeneratedMessageV3 implements KeyRingOrBuilder

A KeyRing is a toplevel logical grouping of CryptoKeys.

Protobuf type google.cloud.kms.v1.KeyRing

Implements

KeyRingOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static KeyRing getDefaultInstance()
Returns
TypeDescription
KeyRing

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static KeyRing.Builder newBuilder()
Returns
TypeDescription
KeyRing.Builder

newBuilder(KeyRing prototype)

public static KeyRing.Builder newBuilder(KeyRing prototype)
Parameter
NameDescription
prototypeKeyRing
Returns
TypeDescription
KeyRing.Builder

parseDelimitedFrom(InputStream input)

public static KeyRing parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRing parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static KeyRing parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KeyRing parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeyRing parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeyRing parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeyRing parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRing parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static KeyRing parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyRing parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static KeyRing parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeyRing parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyRing
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<KeyRing> parser()
Returns
TypeDescription
Parser<KeyRing>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which this KeyRing was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which this KeyRing was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public KeyRing getDefaultInstanceForType()
Returns
TypeDescription
KeyRing

getName()

public String getName()

Output only. The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for the KeyRing in the format projects/*/locations/*/keyRings/*.

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<KeyRing> getParserForType()
Returns
TypeDescription
Parser<KeyRing>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which this KeyRing was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public KeyRing.Builder newBuilderForType()
Returns
TypeDescription
KeyRing.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KeyRing.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
KeyRing.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public KeyRing.Builder toBuilder()
Returns
TypeDescription
KeyRing.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException