Class StartSession (0.1.0)

public final class StartSession extends GeneratedMessage implements StartSessionOrBuilder

Start a new session. The client must send this as the first message to the server to start a new session. The client may immediately send Data messages without waiting for a reply from the server.

Protobuf type google.cloud.sql.v1beta4.StartSession

Static Fields

INSTANCE_ID_FIELD_NUMBER

public static final int INSTANCE_ID_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

SESSION_ID_FIELD_NUMBER

public static final int SESSION_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StartSession getDefaultInstance()
Returns
Type Description
StartSession

getDescriptor()

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

newBuilder()

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

newBuilder(StartSession prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StartSession getDefaultInstanceForType()
Returns
Type Description
StartSession

getInstanceId()

public String getInstanceId()

Required. The Cloud SQL instance resource name, for example: projects/example-project/instances/example-instance

string instance_id = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The instanceId.

getInstanceIdBytes()

public ByteString getInstanceIdBytes()

Required. The Cloud SQL instance resource name, for example: projects/example-project/instances/example-instance

string instance_id = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for instanceId.

getLocationId()

public String getLocationId()

Required. location_id is used to route the request to a specific region. Use the same region which was used to create the instance. Use the format locations/{location}, for example: locations/us-central1.

string location_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Required. location_id is used to route the request to a specific region. Use the same region which was used to create the instance. Use the format locations/{location}, for example: locations/us-central1.

string location_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for locationId.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSessionId()

public String getSessionId()

Optional. The session id, chosen by the client. This should be an unguessable string. If the client does not intend to reconnect to this session, the client may leave session_id unset.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sessionId.

getSessionIdBytes()

public ByteString getSessionIdBytes()

Optional. The session id, chosen by the client. This should be an unguessable string. If the client does not intend to reconnect to this session, the client may leave session_id unset.

string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sessionId.

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 StartSession.Builder newBuilderForType()
Returns
Type Description
StartSession.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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