Class MetadataExchangeRequest (0.9.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
TypeDescription
int

OAUTH2_TOKEN_FIELD_NUMBER

public static final int OAUTH2_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MetadataExchangeRequest getDefaultInstance()
Returns
TypeDescription
MetadataExchangeRequest

getDescriptor()

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

newBuilder()

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

newBuilder(MetadataExchangeRequest prototype)

public static MetadataExchangeRequest.Builder newBuilder(MetadataExchangeRequest prototype)
Parameter
NameDescription
prototypeMetadataExchangeRequest
Returns
TypeDescription
MetadataExchangeRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAuthType()

public MetadataExchangeRequest.AuthType getAuthType()

Authentication type.

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

Returns
TypeDescription
MetadataExchangeRequest.AuthType

The authType.

getAuthTypeValue()

public int getAuthTypeValue()

Authentication type.

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

Returns
TypeDescription
int

The enum numeric value on the wire for authType.

getDefaultInstanceForType()

public MetadataExchangeRequest getDefaultInstanceForType()
Returns
TypeDescription
MetadataExchangeRequest

getOauth2Token()

public String getOauth2Token()

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

string oauth2_token = 3;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for oauth2Token.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUserAgent()

public String getUserAgent()

Optional. Connector information.

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

Returns
TypeDescription
String

The userAgent.

getUserAgentBytes()

public ByteString getUserAgentBytes()

Optional. Connector information.

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

Returns
TypeDescription
ByteString

The bytes for userAgent.

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 MetadataExchangeRequest.Builder newBuilderForType()
Returns
TypeDescription
MetadataExchangeRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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