Package com.google.datastore.v1

Class RunQueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.RunQueryRequest
All Implemented Interfaces:
RunQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class RunQueryRequest extends com.google.protobuf.GeneratedMessageV3 implements RunQueryRequestOrBuilder
 The request for [Datastore.RunQuery][google.datastore.v1.Datastore.RunQuery].
Protobuf type google.datastore.v1.RunQueryRequest
See Also:

  • Field Details

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • DATABASE_ID_FIELD_NUMBER

      public static final int DATABASE_ID_FIELD_NUMBER
      See Also:

    • PARTITION_ID_FIELD_NUMBER

      public static final int PARTITION_ID_FIELD_NUMBER
      See Also:

    • READ_OPTIONS_FIELD_NUMBER

      public static final int READ_OPTIONS_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • GQL_QUERY_FIELD_NUMBER

      public static final int GQL_QUERY_FIELD_NUMBER
      See Also:

    • EXPLAIN_OPTIONS_FIELD_NUMBER

      public static final int EXPLAIN_OPTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • getQueryTypeCase

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

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

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

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

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

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

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

    • 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

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

    • 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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RunQueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunQueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RunQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RunQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RunQueryRequest.Builder newBuilder()

    • newBuilder

      public static RunQueryRequest.Builder newBuilder(RunQueryRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RunQueryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RunQueryRequest> parser()

    • getParserForType

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