Class GqlQuery

  • All Implemented Interfaces:
    GqlQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class GqlQuery
    extends com.google.protobuf.GeneratedMessageV3
    implements GqlQueryOrBuilder
     A [GQL
     query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
     
    Protobuf type google.datastore.v1.GqlQuery
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GqlQuery.Builder
      A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
      • 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 Detail

      • QUERY_STRING_FIELD_NUMBER

        public static final int QUERY_STRING_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ALLOW_LITERALS_FIELD_NUMBER

        public static final int ALLOW_LITERALS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • NAMED_BINDINGS_FIELD_NUMBER

        public static final int NAMED_BINDINGS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • POSITIONAL_BINDINGS_FIELD_NUMBER

        public static final int POSITIONAL_BINDINGS_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()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getQueryString

        public String getQueryString()
         A string of the format described
         [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
         
        string query_string = 1;
        Specified by:
        getQueryString in interface GqlQueryOrBuilder
        Returns:
        The queryString.
      • getQueryStringBytes

        public com.google.protobuf.ByteString getQueryStringBytes()
         A string of the format described
         [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
         
        string query_string = 1;
        Specified by:
        getQueryStringBytes in interface GqlQueryOrBuilder
        Returns:
        The bytes for queryString.
      • getAllowLiterals

        public boolean getAllowLiterals()
         When false, the query string must not contain any literals and instead must
         bind all values. For example,
         `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
         `SELECT * FROM Kind WHERE a = @value` is.
         
        bool allow_literals = 2;
        Specified by:
        getAllowLiterals in interface GqlQueryOrBuilder
        Returns:
        The allowLiterals.
      • getNamedBindingsCount

        public int getNamedBindingsCount()
        Description copied from interface: GqlQueryOrBuilder
         For each non-reserved named binding site in the query string, there must be
         a named parameter with that name, but not necessarily the inverse.
        
         Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
         `__.*__`, and must not be `""`.
         
        map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
        Specified by:
        getNamedBindingsCount in interface GqlQueryOrBuilder
      • containsNamedBindings

        public boolean containsNamedBindings​(String key)
         For each non-reserved named binding site in the query string, there must be
         a named parameter with that name, but not necessarily the inverse.
        
         Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
         `__.*__`, and must not be `""`.
         
        map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
        Specified by:
        containsNamedBindings in interface GqlQueryOrBuilder
      • getNamedBindingsMap

        public Map<String,​GqlQueryParameter> getNamedBindingsMap()
         For each non-reserved named binding site in the query string, there must be
         a named parameter with that name, but not necessarily the inverse.
        
         Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
         `__.*__`, and must not be `""`.
         
        map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
        Specified by:
        getNamedBindingsMap in interface GqlQueryOrBuilder
      • getNamedBindingsOrDefault

        public GqlQueryParameter getNamedBindingsOrDefault​(String key,
                                                           GqlQueryParameter defaultValue)
         For each non-reserved named binding site in the query string, there must be
         a named parameter with that name, but not necessarily the inverse.
        
         Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
         `__.*__`, and must not be `""`.
         
        map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
        Specified by:
        getNamedBindingsOrDefault in interface GqlQueryOrBuilder
      • getNamedBindingsOrThrow

        public GqlQueryParameter getNamedBindingsOrThrow​(String key)
         For each non-reserved named binding site in the query string, there must be
         a named parameter with that name, but not necessarily the inverse.
        
         Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
         `__.*__`, and must not be `""`.
         
        map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
        Specified by:
        getNamedBindingsOrThrow in interface GqlQueryOrBuilder
      • getPositionalBindingsList

        public List<GqlQueryParameter> getPositionalBindingsList()
         Numbered binding site @1 references the first numbered parameter,
         effectively using 1-based indexing, rather than the usual 0.
        
         For each binding site numbered i in `query_string`, there must be an i-th
         numbered parameter. The inverse must also be true.
         
        repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;
        Specified by:
        getPositionalBindingsList in interface GqlQueryOrBuilder
      • getPositionalBindingsOrBuilderList

        public List<? extends GqlQueryParameterOrBuilder> getPositionalBindingsOrBuilderList()
         Numbered binding site @1 references the first numbered parameter,
         effectively using 1-based indexing, rather than the usual 0.
        
         For each binding site numbered i in `query_string`, there must be an i-th
         numbered parameter. The inverse must also be true.
         
        repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;
        Specified by:
        getPositionalBindingsOrBuilderList in interface GqlQueryOrBuilder
      • getPositionalBindingsCount

        public int getPositionalBindingsCount()
         Numbered binding site @1 references the first numbered parameter,
         effectively using 1-based indexing, rather than the usual 0.
        
         For each binding site numbered i in `query_string`, there must be an i-th
         numbered parameter. The inverse must also be true.
         
        repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;
        Specified by:
        getPositionalBindingsCount in interface GqlQueryOrBuilder
      • getPositionalBindings

        public GqlQueryParameter getPositionalBindings​(int index)
         Numbered binding site @1 references the first numbered parameter,
         effectively using 1-based indexing, rather than the usual 0.
        
         For each binding site numbered i in `query_string`, there must be an i-th
         numbered parameter. The inverse must also be true.
         
        repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;
        Specified by:
        getPositionalBindings in interface GqlQueryOrBuilder
      • getPositionalBindingsOrBuilder

        public GqlQueryParameterOrBuilder getPositionalBindingsOrBuilder​(int index)
         Numbered binding site @1 references the first numbered parameter,
         effectively using 1-based indexing, rather than the usual 0.
        
         For each binding site numbered i in `query_string`, there must be an i-th
         numbered parameter. The inverse must also be true.
         
        repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;
        Specified by:
        getPositionalBindingsOrBuilder in interface GqlQueryOrBuilder
      • 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 GqlQuery parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public static GqlQuery getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<GqlQuery> parser()
      • getParserForType

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