Class ExecuteSqlMetadata (0.42.0)

public final class ExecuteSqlMetadata extends GeneratedMessageV3 implements ExecuteSqlMetadataOrBuilder

Any additional metadata information regarding the execution of the SQL

Protobuf type google.cloud.alloydb.v1.ExecuteSqlMetadata

Static Fields

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

PARTIAL_RESULT_FIELD_NUMBER

public static final int PARTIAL_RESULT_FIELD_NUMBER
Field Value
Type Description
int

SQL_STATEMENT_EXECUTION_DURATION_FIELD_NUMBER

public static final int SQL_STATEMENT_EXECUTION_DURATION_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteSqlMetadata getDefaultInstance()
Returns
Type Description
ExecuteSqlMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(ExecuteSqlMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ExecuteSqlMetadata getDefaultInstanceForType()
Returns
Type Description
ExecuteSqlMetadata

getMessage()

public String getMessage()

Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits."

string message = 1;

Returns
Type Description
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits."

string message = 1;

Returns
Type Description
ByteString

The bytes for message.

getParserForType()

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

getPartialResult()

public boolean getPartialResult()

Set to true if SQL returned a result set larger than the acceptable response size limits and the result was truncated.

bool partial_result = 2;

Returns
Type Description
boolean

The partialResult.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSqlStatementExecutionDuration()

public Duration getSqlStatementExecutionDuration()

The time duration taken to execute the sql statement.

.google.protobuf.Duration sql_statement_execution_duration = 3;

Returns
Type Description
Duration

The sqlStatementExecutionDuration.

getSqlStatementExecutionDurationOrBuilder()

public DurationOrBuilder getSqlStatementExecutionDurationOrBuilder()

The time duration taken to execute the sql statement.

.google.protobuf.Duration sql_statement_execution_duration = 3;

Returns
Type Description
DurationOrBuilder

getStatus()

public ExecuteSqlMetadata.Status getStatus()

Status of SQL execution.

.google.cloud.alloydb.v1.ExecuteSqlMetadata.Status status = 4;

Returns
Type Description
ExecuteSqlMetadata.Status

The status.

getStatusValue()

public int getStatusValue()

Status of SQL execution.

.google.cloud.alloydb.v1.ExecuteSqlMetadata.Status status = 4;

Returns
Type Description
int

The enum numeric value on the wire for status.

hasSqlStatementExecutionDuration()

public boolean hasSqlStatementExecutionDuration()

The time duration taken to execute the sql statement.

.google.protobuf.Duration sql_statement_execution_duration = 3;

Returns
Type Description
boolean

Whether the sqlStatementExecutionDuration field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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