Package com.google.cloud.alloydb.connectors.v1alpha

Class MetadataExchangeRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.alloydb.connectors.v1alpha.MetadataExchangeRequest

All Implemented Interfaces:

MetadataExchangeRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class MetadataExchangeRequest
extends com.google.protobuf.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.v1alpha.MetadataExchangeRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataExchangeRequest.AuthType	AuthType contains all supported authentication types.
static class	MetadataExchangeRequest.Builder	Message used by AlloyDB connectors to exchange client and connection metadata with the server after a successful TLS handshake.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	AUTH_TYPE_FIELD_NUMBER
static int	OAUTH2_TOKEN_FIELD_NUMBER
static int	USER_AGENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MetadataExchangeRequest.AuthType	getAuthType()	Authentication type.
int	getAuthTypeValue()	Authentication type.
static MetadataExchangeRequest	getDefaultInstance()
MetadataExchangeRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getOauth2Token()	IAM token used for both IAM user authentiation and `alloydb.instances.connect` permission check.
com.google.protobuf.ByteString	getOauth2TokenBytes()	IAM token used for both IAM user authentiation and `alloydb.instances.connect` permission check.
com.google.protobuf.Parser<MetadataExchangeRequest>	getParserForType()
int	getSerializedSize()
String	getUserAgent()	Optional.
com.google.protobuf.ByteString	getUserAgentBytes()	Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static MetadataExchangeRequest.Builder	newBuilder()
static MetadataExchangeRequest.Builder	newBuilder(MetadataExchangeRequest prototype)
MetadataExchangeRequest.Builder	newBuilderForType()
protected MetadataExchangeRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static MetadataExchangeRequest	parseDelimitedFrom(InputStream input)
static MetadataExchangeRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetadataExchangeRequest	parseFrom(byte[] data)
static MetadataExchangeRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetadataExchangeRequest	parseFrom(com.google.protobuf.ByteString data)
static MetadataExchangeRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetadataExchangeRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static MetadataExchangeRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetadataExchangeRequest	parseFrom(InputStream input)
static MetadataExchangeRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetadataExchangeRequest	parseFrom(ByteBuffer data)
static MetadataExchangeRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<MetadataExchangeRequest>	parser()
MetadataExchangeRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER

See Also:

Constant Field Values

AUTH_TYPE_FIELD_NUMBER

public static final int AUTH_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

OAUTH2_TOKEN_FIELD_NUMBER

public static final int OAUTH2_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getUserAgent

public String getUserAgent()

 Optional. Connector information.
 

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

Specified by:

getUserAgent in interface MetadataExchangeRequestOrBuilder

Returns:

The userAgent.

getUserAgentBytes

public com.google.protobuf.ByteString getUserAgentBytes()

 Optional. Connector information.
 

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

Specified by:

getUserAgentBytes in interface MetadataExchangeRequestOrBuilder

Returns:

The bytes for userAgent.

getAuthTypeValue

public int getAuthTypeValue()

 Authentication type.
 

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

Specified by:

getAuthTypeValue in interface MetadataExchangeRequestOrBuilder

Returns:

The enum numeric value on the wire for authType.

getAuthType

public MetadataExchangeRequest.AuthType getAuthType()

 Authentication type.
 

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

Specified by:

getAuthType in interface MetadataExchangeRequestOrBuilder

Returns:

The authType.

getOauth2Token

public String getOauth2Token()

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

string oauth2_token = 3;

Specified by:

getOauth2Token in interface MetadataExchangeRequestOrBuilder

Returns:

The oauth2Token.

getOauth2TokenBytes

public com.google.protobuf.ByteString getOauth2TokenBytes()

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

string oauth2_token = 3;

Specified by:

getOauth2TokenBytes in interface MetadataExchangeRequestOrBuilder

Returns:

The bytes for oauth2Token.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static MetadataExchangeRequest parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetadataExchangeRequest parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetadataExchangeRequest parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetadataExchangeRequest parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetadataExchangeRequest parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetadataExchangeRequest parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetadataExchangeRequest parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static MetadataExchangeRequest parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static MetadataExchangeRequest parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static MetadataExchangeRequest parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static MetadataExchangeRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static MetadataExchangeRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public MetadataExchangeRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static MetadataExchangeRequest.Builder newBuilder()

newBuilder

public static MetadataExchangeRequest.Builder newBuilder(MetadataExchangeRequest prototype)

toBuilder

public MetadataExchangeRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected MetadataExchangeRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static MetadataExchangeRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<MetadataExchangeRequest> parser()

getParserForType

public com.google.protobuf.Parser<MetadataExchangeRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public MetadataExchangeRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder