Package com.google.datastore.v1

Class GqlQuery.Builder

  • All Implemented Interfaces:
    GqlQueryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    GqlQuery
    public static final class GqlQuery.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>
implements GqlQueryOrBuilder
     A [GQL
 query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
    Protobuf type google.datastore.v1.GqlQuery

    • Method Detail

      • 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.Builder<GqlQuery.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • clear

        public GqlQuery.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • getDefaultInstanceForType

        public GqlQuery getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public GqlQuery.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • setField

        public GqlQuery.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • clearField

        public GqlQuery.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • clearOneof

        public GqlQuery.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • setRepeatedField

        public GqlQuery.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • addRepeatedField

        public GqlQuery.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • mergeFrom

        public GqlQuery.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GqlQuery.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • mergeFrom

        public GqlQuery.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GqlQuery.Builder>
        Throws:
        IOException

      • 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.

      • setQueryString

        public GqlQuery.Builder setQueryString​(String value)
         A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
        string query_string = 1;
        Parameters:
        value - The queryString to set.
        Returns:
        This builder for chaining.

      • clearQueryString

        public GqlQuery.Builder clearQueryString()
         A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
        string query_string = 1;
        Returns:
        This builder for chaining.

      • setQueryStringBytes

        public GqlQuery.Builder setQueryStringBytes​(com.google.protobuf.ByteString value)
         A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
        string query_string = 1;
        Parameters:
        value - The bytes for queryString to set.
        Returns:
        This builder for chaining.

      • 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.

      • setAllowLiterals

        public GqlQuery.Builder setAllowLiterals​(boolean value)
         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;
        Parameters:
        value - The allowLiterals to set.
        Returns:
        This builder for chaining.

      • clearAllowLiterals

        public GqlQuery.Builder clearAllowLiterals()
         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;
        Returns:
        This builder for chaining.

      • 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

      • removeNamedBindings

        public GqlQuery.Builder removeNamedBindings​(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;

      • putNamedBindings

        public GqlQuery.Builder putNamedBindings​(String key,
                                         GqlQueryParameter value)
         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;

      • putAllNamedBindings

        public GqlQuery.Builder putAllNamedBindings​(Map<String,​GqlQueryParameter> values)
         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;

      • 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

      • 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

      • setPositionalBindings

        public GqlQuery.Builder setPositionalBindings​(int index,
                                              GqlQueryParameter value)
         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;

      • setPositionalBindings

        public GqlQuery.Builder setPositionalBindings​(int index,
                                              GqlQueryParameter.Builder builderForValue)
         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;

      • addPositionalBindings

        public GqlQuery.Builder addPositionalBindings​(GqlQueryParameter value)
         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;

      • addPositionalBindings

        public GqlQuery.Builder addPositionalBindings​(int index,
                                              GqlQueryParameter value)
         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;

      • addPositionalBindings

        public GqlQuery.Builder addPositionalBindings​(GqlQueryParameter.Builder builderForValue)
         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;

      • addPositionalBindings

        public GqlQuery.Builder addPositionalBindings​(int index,
                                              GqlQueryParameter.Builder builderForValue)
         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;

      • addAllPositionalBindings

        public GqlQuery.Builder addAllPositionalBindings​(Iterable<? extends GqlQueryParameter> values)
         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;

      • clearPositionalBindings

        public GqlQuery.Builder clearPositionalBindings()
         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;

      • removePositionalBindings

        public GqlQuery.Builder removePositionalBindings​(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;

      • getPositionalBindingsBuilder

        public GqlQueryParameter.Builder getPositionalBindingsBuilder​(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;

      • 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

      • 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

      • addPositionalBindingsBuilder

        public GqlQueryParameter.Builder addPositionalBindingsBuilder()
         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;

      • addPositionalBindingsBuilder

        public GqlQueryParameter.Builder addPositionalBindingsBuilder​(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;

      • getPositionalBindingsBuilderList

        public List<GqlQueryParameter.Builder> getPositionalBindingsBuilderList()
         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;

      • setUnknownFields

        public final GqlQuery.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

      • mergeUnknownFields

        public final GqlQuery.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>