Package com.google.datastore.v1

Class RunQueryRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder>
com.google.datastore.v1.RunQueryRequest.Builder
All Implemented Interfaces:
RunQueryRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RunQueryRequest
public static final class RunQueryRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RunQueryRequest.Builder> implements RunQueryRequestOrBuilder
 The request for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
Protobuf type google.datastore.v1.RunQueryRequest

  • Method Details

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

    • clear

      public RunQueryRequest.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<RunQueryRequest.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<RunQueryRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • setField

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • clearField

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • clearOneof

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • setRepeatedField

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • addRepeatedField

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • mergeFrom

      public RunQueryRequest.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<RunQueryRequest.Builder>

    • mergeFrom

      public RunQueryRequest.Builder mergeFrom(RunQueryRequest other)

    • isInitialized

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

    • mergeFrom

      public RunQueryRequest.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<RunQueryRequest.Builder>
      Throws:
      IOException

    • getQueryTypeCase

      public RunQueryRequest.QueryTypeCase getQueryTypeCase()
      Specified by:
      getQueryTypeCase in interface RunQueryRequestOrBuilder

    • clearQueryType

      public RunQueryRequest.Builder clearQueryType()

    • getProjectId

      public String getProjectId()
       Required. The ID of the project against which to make the request.
      string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectId in interface RunQueryRequestOrBuilder
      Returns:
      The projectId.

    • getProjectIdBytes

      public com.google.protobuf.ByteString getProjectIdBytes()
       Required. The ID of the project against which to make the request.
      string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getProjectIdBytes in interface RunQueryRequestOrBuilder
      Returns:
      The bytes for projectId.

    • setProjectId

      public RunQueryRequest.Builder setProjectId(String value)
       Required. The ID of the project against which to make the request.
      string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The projectId to set.
      Returns:
      This builder for chaining.

    • clearProjectId

      public RunQueryRequest.Builder clearProjectId()
       Required. The ID of the project against which to make the request.
      string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setProjectIdBytes

      public RunQueryRequest.Builder setProjectIdBytes(com.google.protobuf.ByteString value)
       Required. The ID of the project against which to make the request.
      string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for projectId to set.
      Returns:
      This builder for chaining.

    • getDatabaseId

      public String getDatabaseId()
       The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
      string database_id = 9;
      Specified by:
      getDatabaseId in interface RunQueryRequestOrBuilder
      Returns:
      The databaseId.

    • getDatabaseIdBytes

      public com.google.protobuf.ByteString getDatabaseIdBytes()
       The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
      string database_id = 9;
      Specified by:
      getDatabaseIdBytes in interface RunQueryRequestOrBuilder
      Returns:
      The bytes for databaseId.

    • setDatabaseId

      public RunQueryRequest.Builder setDatabaseId(String value)
       The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
      string database_id = 9;
      Parameters:
      value - The databaseId to set.
      Returns:
      This builder for chaining.

    • clearDatabaseId

      public RunQueryRequest.Builder clearDatabaseId()
       The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
      string database_id = 9;
      Returns:
      This builder for chaining.

    • setDatabaseIdBytes

      public RunQueryRequest.Builder setDatabaseIdBytes(com.google.protobuf.ByteString value)
       The ID of the database against which to make the request.

 '(default)' is not allowed; please use empty string '' to refer the default
 database.
      string database_id = 9;
      Parameters:
      value - The bytes for databaseId to set.
      Returns:
      This builder for chaining.

    • hasPartitionId

      public boolean hasPartitionId()
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;
      Specified by:
      hasPartitionId in interface RunQueryRequestOrBuilder
      Returns:
      Whether the partitionId field is set.

    • getPartitionId

      public PartitionId getPartitionId()
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;
      Specified by:
      getPartitionId in interface RunQueryRequestOrBuilder
      Returns:
      The partitionId.

    • setPartitionId

      public RunQueryRequest.Builder setPartitionId(PartitionId value)
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;

    • setPartitionId

      public RunQueryRequest.Builder setPartitionId(PartitionId.Builder builderForValue)
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;

    • mergePartitionId

      public RunQueryRequest.Builder mergePartitionId(PartitionId value)
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;

    • clearPartitionId

      public RunQueryRequest.Builder clearPartitionId()
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;

    • getPartitionIdBuilder

      public PartitionId.Builder getPartitionIdBuilder()
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;

    • getPartitionIdOrBuilder

      public PartitionIdOrBuilder getPartitionIdOrBuilder()
       Entities are partitioned into subsets, identified by a partition ID.
 Queries are scoped to a single partition.
 This partition ID is normalized with the standard default context
 partition ID.
      .google.datastore.v1.PartitionId partition_id = 2;
      Specified by:
      getPartitionIdOrBuilder in interface RunQueryRequestOrBuilder

    • hasReadOptions

      public boolean hasReadOptions()
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;
      Specified by:
      hasReadOptions in interface RunQueryRequestOrBuilder
      Returns:
      Whether the readOptions field is set.

    • getReadOptions

      public ReadOptions getReadOptions()
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;
      Specified by:
      getReadOptions in interface RunQueryRequestOrBuilder
      Returns:
      The readOptions.

    • setReadOptions

      public RunQueryRequest.Builder setReadOptions(ReadOptions value)
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;

    • setReadOptions

      public RunQueryRequest.Builder setReadOptions(ReadOptions.Builder builderForValue)
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;

    • mergeReadOptions

      public RunQueryRequest.Builder mergeReadOptions(ReadOptions value)
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;

    • clearReadOptions

      public RunQueryRequest.Builder clearReadOptions()
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;

    • getReadOptionsBuilder

      public ReadOptions.Builder getReadOptionsBuilder()
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;

    • getReadOptionsOrBuilder

      public ReadOptionsOrBuilder getReadOptionsOrBuilder()
       The options for this query.
      .google.datastore.v1.ReadOptions read_options = 1;
      Specified by:
      getReadOptionsOrBuilder in interface RunQueryRequestOrBuilder

    • hasQuery

      public boolean hasQuery()
       The query to run.
      .google.datastore.v1.Query query = 3;
      Specified by:
      hasQuery in interface RunQueryRequestOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public Query getQuery()
       The query to run.
      .google.datastore.v1.Query query = 3;
      Specified by:
      getQuery in interface RunQueryRequestOrBuilder
      Returns:
      The query.

    • setQuery

      public RunQueryRequest.Builder setQuery(Query value)
       The query to run.
      .google.datastore.v1.Query query = 3;

    • setQuery

      public RunQueryRequest.Builder setQuery(Query.Builder builderForValue)
       The query to run.
      .google.datastore.v1.Query query = 3;

    • mergeQuery

      public RunQueryRequest.Builder mergeQuery(Query value)
       The query to run.
      .google.datastore.v1.Query query = 3;

    • clearQuery

      public RunQueryRequest.Builder clearQuery()
       The query to run.
      .google.datastore.v1.Query query = 3;

    • getQueryBuilder

      public Query.Builder getQueryBuilder()
       The query to run.
      .google.datastore.v1.Query query = 3;

    • getQueryOrBuilder

      public QueryOrBuilder getQueryOrBuilder()
       The query to run.
      .google.datastore.v1.Query query = 3;
      Specified by:
      getQueryOrBuilder in interface RunQueryRequestOrBuilder

    • hasGqlQuery

      public boolean hasGqlQuery()
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;
      Specified by:
      hasGqlQuery in interface RunQueryRequestOrBuilder
      Returns:
      Whether the gqlQuery field is set.

    • getGqlQuery

      public GqlQuery getGqlQuery()
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;
      Specified by:
      getGqlQuery in interface RunQueryRequestOrBuilder
      Returns:
      The gqlQuery.

    • setGqlQuery

      public RunQueryRequest.Builder setGqlQuery(GqlQuery value)
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;

    • setGqlQuery

      public RunQueryRequest.Builder setGqlQuery(GqlQuery.Builder builderForValue)
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;

    • mergeGqlQuery

      public RunQueryRequest.Builder mergeGqlQuery(GqlQuery value)
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;

    • clearGqlQuery

      public RunQueryRequest.Builder clearGqlQuery()
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;

    • getGqlQueryBuilder

      public GqlQuery.Builder getGqlQueryBuilder()
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;

    • getGqlQueryOrBuilder

      public GqlQueryOrBuilder getGqlQueryOrBuilder()
       The GQL query to run. This query must be a non-aggregation query.
      .google.datastore.v1.GqlQuery gql_query = 7;
      Specified by:
      getGqlQueryOrBuilder in interface RunQueryRequestOrBuilder

    • hasPropertyMask

      public boolean hasPropertyMask()
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;
      Specified by:
      hasPropertyMask in interface RunQueryRequestOrBuilder
      Returns:
      Whether the propertyMask field is set.

    • getPropertyMask

      public PropertyMask getPropertyMask()
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;
      Specified by:
      getPropertyMask in interface RunQueryRequestOrBuilder
      Returns:
      The propertyMask.

    • setPropertyMask

      public RunQueryRequest.Builder setPropertyMask(PropertyMask value)
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;

    • setPropertyMask

      public RunQueryRequest.Builder setPropertyMask(PropertyMask.Builder builderForValue)
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;

    • mergePropertyMask

      public RunQueryRequest.Builder mergePropertyMask(PropertyMask value)
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;

    • clearPropertyMask

      public RunQueryRequest.Builder clearPropertyMask()
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;

    • getPropertyMaskBuilder

      public PropertyMask.Builder getPropertyMaskBuilder()
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;

    • getPropertyMaskOrBuilder

      public PropertyMaskOrBuilder getPropertyMaskOrBuilder()
       The properties to return.
 This field must not be set for a projection query.

 See
 [LookupRequest.property_mask][google.datastore.v1.LookupRequest.property_mask].
      .google.datastore.v1.PropertyMask property_mask = 10;
      Specified by:
      getPropertyMaskOrBuilder in interface RunQueryRequestOrBuilder

    • hasExplainOptions

      public boolean hasExplainOptions()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExplainOptions in interface RunQueryRequestOrBuilder
      Returns:
      Whether the explainOptions field is set.

    • getExplainOptions

      public ExplainOptions getExplainOptions()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExplainOptions in interface RunQueryRequestOrBuilder
      Returns:
      The explainOptions.

    • setExplainOptions

      public RunQueryRequest.Builder setExplainOptions(ExplainOptions value)
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

    • setExplainOptions

      public RunQueryRequest.Builder setExplainOptions(ExplainOptions.Builder builderForValue)
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

    • mergeExplainOptions

      public RunQueryRequest.Builder mergeExplainOptions(ExplainOptions value)
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

    • clearExplainOptions

      public RunQueryRequest.Builder clearExplainOptions()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getExplainOptionsBuilder

      public ExplainOptions.Builder getExplainOptionsBuilder()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getExplainOptionsOrBuilder

      public ExplainOptionsOrBuilder getExplainOptionsOrBuilder()
       Optional. Explain options for the query. If set, additional query
 statistics will be returned. If not, only query results will be returned.
      .google.datastore.v1.ExplainOptions explain_options = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExplainOptionsOrBuilder in interface RunQueryRequestOrBuilder

    • setUnknownFields

      public final RunQueryRequest.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<RunQueryRequest.Builder>

    • mergeUnknownFields

      public final RunQueryRequest.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<RunQueryRequest.Builder>