Class MetadataExchangeRequest (0.21.0)

public final class MetadataExchangeRequest extends GeneratedMessageV3 implements MetadataExchangeRequestOrBuilder

Message used by AlloyDB connectors to exchange client and connection metadata with the server after a successful TLS handshake. This metadata includes an IAM token, which is used to authenticate users based on their IAM identity. The sole purpose of this message is for the use of AlloyDB connectors. Clients should not rely on this message directly as there can be breaking changes in the future.

Protobuf type google.cloud.alloydb.connectors.v1beta.MetadataExchangeRequest

Static Fields

AUTH_TYPE_FIELD_NUMBER

public static final int AUTH_TYPE_FIELD_NUMBER
Field Value
Type Description
int

OAUTH2_TOKEN_FIELD_NUMBER

public static final int OAUTH2_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetadataExchangeRequest getDefaultInstance()
Returns
Type Description
MetadataExchangeRequest

getDescriptor()

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

newBuilder()

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

newBuilder(MetadataExchangeRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAuthType()

public MetadataExchangeRequest.AuthType getAuthType()

Authentication type.

.google.cloud.alloydb.connectors.v1beta.MetadataExchangeRequest.AuthType auth_type = 2;

Returns
Type Description
MetadataExchangeRequest.AuthType

The authType.

getAuthTypeValue()

public int getAuthTypeValue()

Authentication type.

.google.cloud.alloydb.connectors.v1beta.MetadataExchangeRequest.AuthType auth_type = 2;

Returns
Type Description
int

The enum numeric value on the wire for authType.

getDefaultInstanceForType()

public MetadataExchangeRequest getDefaultInstanceForType()
Returns
Type Description
MetadataExchangeRequest

getOauth2Token()

public String getOauth2Token()

IAM token used for both IAM user authentiation and alloydb.instances.connect permission check.

string oauth2_token = 3;

Returns
Type Description
String

The oauth2Token.

getOauth2TokenBytes()

public ByteString getOauth2TokenBytes()

IAM token used for both IAM user authentiation and alloydb.instances.connect permission check.

string oauth2_token = 3;

Returns
Type Description
ByteString

The bytes for oauth2Token.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserAgent()

public String getUserAgent()

Optional. Connector information.

string user_agent = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The userAgent.

getUserAgentBytes()

public ByteString getUserAgentBytes()

Optional. Connector information.

string user_agent = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for userAgent.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetadataExchangeRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetadataExchangeRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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