Package com.google.spanner.v1

Class ResultSetMetadata

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ResultSetMetadataOrBuilder, Serializable
    public final class ResultSetMetadata
extends com.google.protobuf.GeneratedMessageV3
implements ResultSetMetadataOrBuilder
     Metadata about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
    Protobuf type google.spanner.v1.ResultSetMetadata
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ResultSetMetadata.Builder
      Metadata about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].

      • 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 ROW_TYPE_FIELD_NUMBER  
      static int TRANSACTION_FIELD_NUMBER  
      static int UNDECLARED_PARAMETERS_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

    • Field Detail

      • TRANSACTION_FIELD_NUMBER

        public static final int TRANSACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UNDECLARED_PARAMETERS_FIELD_NUMBER

        public static final int UNDECLARED_PARAMETERS_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

      • hasRowType

        public boolean hasRowType()
         Indicates the field names and types for the rows in the result
 set.  For example, a SQL query like `"SELECT UserId, UserName FROM
 Users"` could return a `row_type` value like:

     "fields": [
       { "name": "UserId", "type": { "code": "INT64" } },
       { "name": "UserName", "type": { "code": "STRING" } },
     ]
        .google.spanner.v1.StructType row_type = 1;
        Specified by:
        hasRowType in interface ResultSetMetadataOrBuilder
        Returns:
        Whether the rowType field is set.

      • getRowType

        public StructType getRowType()
         Indicates the field names and types for the rows in the result
 set.  For example, a SQL query like `"SELECT UserId, UserName FROM
 Users"` could return a `row_type` value like:

     "fields": [
       { "name": "UserId", "type": { "code": "INT64" } },
       { "name": "UserName", "type": { "code": "STRING" } },
     ]
        .google.spanner.v1.StructType row_type = 1;
        Specified by:
        getRowType in interface ResultSetMetadataOrBuilder
        Returns:
        The rowType.

      • getRowTypeOrBuilder

        public StructTypeOrBuilder getRowTypeOrBuilder()
         Indicates the field names and types for the rows in the result
 set.  For example, a SQL query like `"SELECT UserId, UserName FROM
 Users"` could return a `row_type` value like:

     "fields": [
       { "name": "UserId", "type": { "code": "INT64" } },
       { "name": "UserName", "type": { "code": "STRING" } },
     ]
        .google.spanner.v1.StructType row_type = 1;
        Specified by:
        getRowTypeOrBuilder in interface ResultSetMetadataOrBuilder

      • hasTransaction

        public boolean hasTransaction()
         If the read or SQL query began a transaction as a side-effect, the
 information about the new transaction is yielded here.
        .google.spanner.v1.Transaction transaction = 2;
        Specified by:
        hasTransaction in interface ResultSetMetadataOrBuilder
        Returns:
        Whether the transaction field is set.

      • getTransaction

        public Transaction getTransaction()
         If the read or SQL query began a transaction as a side-effect, the
 information about the new transaction is yielded here.
        .google.spanner.v1.Transaction transaction = 2;
        Specified by:
        getTransaction in interface ResultSetMetadataOrBuilder
        Returns:
        The transaction.

      • hasUndeclaredParameters

        public boolean hasUndeclaredParameters()
         A SQL query can be parameterized. In PLAN mode, these parameters can be
 undeclared. This indicates the field names and types for those undeclared
 parameters in the SQL query. For example, a SQL query like `"SELECT * FROM
 Users where UserId = @userId and UserName = @userName "` could return a
 `undeclared_parameters` value like:

     "fields": [
       { "name": "UserId", "type": { "code": "INT64" } },
       { "name": "UserName", "type": { "code": "STRING" } },
     ]
        .google.spanner.v1.StructType undeclared_parameters = 3;
        Specified by:
        hasUndeclaredParameters in interface ResultSetMetadataOrBuilder
        Returns:
        Whether the undeclaredParameters field is set.

      • getUndeclaredParameters

        public StructType getUndeclaredParameters()
         A SQL query can be parameterized. In PLAN mode, these parameters can be
 undeclared. This indicates the field names and types for those undeclared
 parameters in the SQL query. For example, a SQL query like `"SELECT * FROM
 Users where UserId = @userId and UserName = @userName "` could return a
 `undeclared_parameters` value like:

     "fields": [
       { "name": "UserId", "type": { "code": "INT64" } },
       { "name": "UserName", "type": { "code": "STRING" } },
     ]
        .google.spanner.v1.StructType undeclared_parameters = 3;
        Specified by:
        getUndeclaredParameters in interface ResultSetMetadataOrBuilder
        Returns:
        The undeclaredParameters.

      • getUndeclaredParametersOrBuilder

        public StructTypeOrBuilder getUndeclaredParametersOrBuilder()
         A SQL query can be parameterized. In PLAN mode, these parameters can be
 undeclared. This indicates the field names and types for those undeclared
 parameters in the SQL query. For example, a SQL query like `"SELECT * FROM
 Users where UserId = @userId and UserName = @userName "` could return a
 `undeclared_parameters` value like:

     "fields": [
       { "name": "UserId", "type": { "code": "INT64" } },
       { "name": "UserName", "type": { "code": "STRING" } },
     ]
        .google.spanner.v1.StructType undeclared_parameters = 3;
        Specified by:
        getUndeclaredParametersOrBuilder in interface ResultSetMetadataOrBuilder

      • 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 ResultSetMetadata parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResultSetMetadata parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResultSetMetadata parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResultSetMetadata parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResultSetMetadata parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResultSetMetadata parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ResultSetMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ResultSetMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ResultSetMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ResultSetMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ResultSetMetadata> 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 ResultSetMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder