Class Secret (1.102.0)

public final class Secret extends GeneratedMessage implements SecretOrBuilder

A confidential piece of information where the actual value is either directly specified in the message as a raw string or stored in GCP secret manager.

Protobuf type google.cloud.datastream.v1.Secret

Implements

SecretOrBuilder

Static Fields

RAW_VALUE_FIELD_NUMBER

public static final int RAW_VALUE_FIELD_NUMBER
Field Value
Type Description
int

SECRET_VERSION_FIELD_NUMBER

public static final int SECRET_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Secret getDefaultInstance()
Returns
Type Description
Secret

getDescriptor()

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

newBuilder()

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

newBuilder(Secret prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Secret getDefaultInstanceForType()
Returns
Type Description
Secret

getParserForType()

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

getRawValue()

public String getRawValue()

Optional. Input only. The actual raw value of the secret as plain text.

string raw_value = 1 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The rawValue.

getRawValueBytes()

public ByteString getRawValueBytes()

Optional. Input only. The actual raw value of the secret as plain text.

string raw_value = 1 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for rawValue.

getSecretVersion()

public String getSecretVersion()

Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats:

  • projects/{project}/locations/{location}/secrets/{secret}/versions/{version}
  • projects/{project}/secrets/{secret}/versions/{version}

string secret_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The secretVersion.

getSecretVersionBytes()

public ByteString getSecretVersionBytes()

Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats:

  • projects/{project}/locations/{location}/secrets/{secret}/versions/{version}
  • projects/{project}/secrets/{secret}/versions/{version}

string secret_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for secretVersion.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValueCase()

public Secret.ValueCase getValueCase()
Returns
Type Description
Secret.ValueCase

hasRawValue()

public boolean hasRawValue()

Optional. Input only. The actual raw value of the secret as plain text.

string raw_value = 1 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the rawValue field is set.

hasSecretVersion()

public boolean hasSecretVersion()

Optional. A Secret Manager resource name storing the actual value of the secret. Supported formats:

  • projects/{project}/locations/{location}/secrets/{secret}/versions/{version}
  • projects/{project}/secrets/{secret}/versions/{version}

string secret_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the secretVersion 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 Secret.Builder newBuilderForType()
Returns
Type Description
Secret.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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