Interface RunQueryRequestOrBuilder (2.25.1)

public interface RunQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDatabaseId()

public abstract 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;

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for databaseId.

getExplainOptions()

public abstract 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];

Returns
Type Description
ExplainOptions

The explainOptions.

getExplainOptionsOrBuilder()

public abstract 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];

Returns
Type Description
ExplainOptionsOrBuilder

getGqlQuery()

public abstract GqlQuery getGqlQuery()

The GQL query to run. This query must be a non-aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type Description
GqlQuery

The gqlQuery.

getGqlQueryOrBuilder()

public abstract GqlQueryOrBuilder getGqlQueryOrBuilder()

The GQL query to run. This query must be a non-aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type Description
GqlQueryOrBuilder

getPartitionId()

public abstract 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;

Returns
Type Description
PartitionId

The partitionId.

getPartitionIdOrBuilder()

public abstract 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;

Returns
Type Description
PartitionIdOrBuilder

getProjectId()

public abstract String getProjectId()

Required. The ID of the project against which to make the request.

string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

Required. The ID of the project against which to make the request.

string project_id = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for projectId.

getPropertyMask()

public abstract PropertyMask getPropertyMask()

The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

.google.datastore.v1.PropertyMask property_mask = 10;

Returns
Type Description
PropertyMask

The propertyMask.

getPropertyMaskOrBuilder()

public abstract PropertyMaskOrBuilder getPropertyMaskOrBuilder()

The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

.google.datastore.v1.PropertyMask property_mask = 10;

Returns
Type Description
PropertyMaskOrBuilder

getQuery()

public abstract Query getQuery()

The query to run.

.google.datastore.v1.Query query = 3;

Returns
Type Description
Query

The query.

getQueryOrBuilder()

public abstract QueryOrBuilder getQueryOrBuilder()

The query to run.

.google.datastore.v1.Query query = 3;

Returns
Type Description
QueryOrBuilder

getQueryTypeCase()

public abstract RunQueryRequest.QueryTypeCase getQueryTypeCase()
Returns
Type Description
RunQueryRequest.QueryTypeCase

getReadOptions()

public abstract ReadOptions getReadOptions()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
ReadOptions

The readOptions.

getReadOptionsOrBuilder()

public abstract ReadOptionsOrBuilder getReadOptionsOrBuilder()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
ReadOptionsOrBuilder

hasExplainOptions()

public abstract 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];

Returns
Type Description
boolean

Whether the explainOptions field is set.

hasGqlQuery()

public abstract boolean hasGqlQuery()

The GQL query to run. This query must be a non-aggregation query.

.google.datastore.v1.GqlQuery gql_query = 7;

Returns
Type Description
boolean

Whether the gqlQuery field is set.

hasPartitionId()

public abstract 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;

Returns
Type Description
boolean

Whether the partitionId field is set.

hasPropertyMask()

public abstract boolean hasPropertyMask()

The properties to return. This field must not be set for a projection query.

See LookupRequest.property_mask.

.google.datastore.v1.PropertyMask property_mask = 10;

Returns
Type Description
boolean

Whether the propertyMask field is set.

hasQuery()

public abstract boolean hasQuery()

The query to run.

.google.datastore.v1.Query query = 3;

Returns
Type Description
boolean

Whether the query field is set.

hasReadOptions()

public abstract boolean hasReadOptions()

The options for this query.

.google.datastore.v1.ReadOptions read_options = 1;

Returns
Type Description
boolean

Whether the readOptions field is set.