@googleapis/datastore
Version:
1,155 lines (1,146 loc) • 168 kB
text/typescript
// Copyright 2020 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/no-unused-vars */
/* eslint-disable @typescript-eslint/no-empty-interface */
/* eslint-disable @typescript-eslint/no-namespace */
/* eslint-disable no-irregular-whitespace */
import {
OAuth2Client,
JWT,
Compute,
UserRefreshClient,
BaseExternalAccountClient,
GaxiosResponseWithHTTP2,
GoogleConfigurable,
createAPIRequest,
MethodOptions,
StreamMethodOptions,
GlobalOptions,
GoogleAuth,
BodyResponseCallback,
APIRequestContext,
} from 'googleapis-common';
import {Readable} from 'stream';
export namespace datastore_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?:
| string
| OAuth2Client
| JWT
| Compute
| UserRefreshClient
| BaseExternalAccountClient
| GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Datastore API
*
* Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.
*
* @example
* ```js
* const {google} = require('googleapis');
* const datastore = google.datastore('v1');
* ```
*/
export class Datastore {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this.context = {
_options: options || {},
google,
};
this.projects = new Resource$Projects(this.context);
}
}
/**
* Defines an aggregation that produces a single result.
*/
export interface Schema$Aggregation {
/**
* Optional. Optional name of the property to store the result of the aggregation. If not provided, Datastore will pick a default name following the format `property_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation aliases. * Conform to entity property name limitations.
*/
alias?: string | null;
/**
* Average aggregator.
*/
avg?: Schema$Avg;
/**
* Count aggregator.
*/
count?: Schema$Count;
/**
* Sum aggregator.
*/
sum?: Schema$Sum;
}
/**
* Datastore query for running an aggregation over a Query.
*/
export interface Schema$AggregationQuery {
/**
* Optional. Series of aggregations to apply over the results of the `nested_query`. Requires: * A minimum of one and maximum of five aggregations per query.
*/
aggregations?: Schema$Aggregation[];
/**
* Nested query for aggregation
*/
nestedQuery?: Schema$Query;
}
/**
* The result of a single bucket from a Datastore aggregation query. The keys of `aggregate_properties` are the same for all results in an aggregation query, unlike entity queries which can have different fields present for each result.
*/
export interface Schema$AggregationResult {
/**
* The result of the aggregation functions, ex: `COUNT(*) AS total_entities`. The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.
*/
aggregateProperties?: {[key: string]: Schema$Value} | null;
}
/**
* A batch of aggregation results produced by an aggregation query.
*/
export interface Schema$AggregationResultBatch {
/**
* The aggregation results for this batch.
*/
aggregationResults?: Schema$AggregationResult[];
/**
* The state of the query after the current batch. Only COUNT(*) aggregations are supported in the initial launch. Therefore, expected result type is limited to `NO_MORE_RESULTS`.
*/
moreResults?: string | null;
/**
* Read timestamp this batch was returned from. In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches.
*/
readTime?: string | null;
}
/**
* The request for Datastore.AllocateIds.
*/
export interface Schema$AllocateIdsRequest {
/**
* The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.
*/
databaseId?: string | null;
/**
* Required. A list of keys with incomplete key paths for which to allocate IDs. No key may be reserved/read-only.
*/
keys?: Schema$Key[];
}
/**
* The response for Datastore.AllocateIds.
*/
export interface Schema$AllocateIdsResponse {
/**
* The keys specified in the request (in the same order), each with its key path completed with a newly allocated ID.
*/
keys?: Schema$Key[];
}
/**
* An array value.
*/
export interface Schema$ArrayValue {
/**
* Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'.
*/
values?: Schema$Value[];
}
/**
* Average of the values of the requested property. * Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped. * If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns `NULL`. * Always returns the result as a double.
*/
export interface Schema$Avg {
/**
* The property to aggregate on.
*/
property?: Schema$PropertyReference;
}
/**
* The request for Datastore.BeginTransaction.
*/
export interface Schema$BeginTransactionRequest {
/**
* The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.
*/
databaseId?: string | null;
/**
* Options for a new transaction.
*/
transactionOptions?: Schema$TransactionOptions;
}
/**
* The response for Datastore.BeginTransaction.
*/
export interface Schema$BeginTransactionResponse {
/**
* The transaction identifier (always present).
*/
transaction?: string | null;
}
/**
* The request for Datastore.Commit.
*/
export interface Schema$CommitRequest {
/**
* The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.
*/
databaseId?: string | null;
/**
* The type of commit to perform. Defaults to `TRANSACTIONAL`.
*/
mode?: string | null;
/**
* The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single `Commit` request: - `insert` followed by `insert` - `update` followed by `insert` - `upsert` followed by `insert` - `delete` followed by `update` When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single entity.
*/
mutations?: Schema$Mutation[];
/**
* Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.
*/
singleUseTransaction?: Schema$TransactionOptions;
/**
* The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.
*/
transaction?: string | null;
}
/**
* The response for Datastore.Commit.
*/
export interface Schema$CommitResponse {
/**
* The transaction commit timestamp. Not set for non-transactional commits.
*/
commitTime?: string | null;
/**
* The number of index entries updated during the commit, or zero if none were updated.
*/
indexUpdates?: number | null;
/**
* The result of performing the mutations. The i-th mutation result corresponds to the i-th mutation in the request.
*/
mutationResults?: Schema$MutationResult[];
}
/**
* A filter that merges multiple other filters using the given operator.
*/
export interface Schema$CompositeFilter {
/**
* The list of filters to combine. Requires: * At least one filter is present.
*/
filters?: Schema$Filter[];
/**
* The operator for combining multiple filters.
*/
op?: string | null;
}
/**
* Count of entities that match the query. The `COUNT(*)` aggregation function operates on the entire entity so it does not require a field reference.
*/
export interface Schema$Count {
/**
* Optional. Optional constraint on the maximum number of entities to count. This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be non-negative when present.
*/
upTo?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {}
/**
* A Datastore data object. Must not exceed 1 MiB - 4 bytes.
*/
export interface Schema$Entity {
/**
* The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key.
*/
key?: Schema$Key;
/**
* The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty.
*/
properties?: {[key: string]: Schema$Value} | null;
}
/**
* The result of fetching an entity from Datastore.
*/
export interface Schema$EntityResult {
/**
* The time at which the entity was created. This field is set for `FULL` entity results. If this entity is missing, this field will not be set.
*/
createTime?: string | null;
/**
* A cursor that points to the position after the result entity. Set only when the `EntityResult` is part of a `QueryResultBatch` message.
*/
cursor?: string | null;
/**
* The resulting entity.
*/
entity?: Schema$Entity;
/**
* The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set.
*/
updateTime?: string | null;
/**
* The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads.
*/
version?: string | null;
}
/**
* Execution statistics for the query.
*/
export interface Schema$ExecutionStats {
/**
* Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" \} \}
*/
debugStats?: {[key: string]: any} | null;
/**
* Total time to execute the query in the backend.
*/
executionDuration?: string | null;
/**
* Total billable read operations.
*/
readOperations?: string | null;
/**
* Total number of results returned, including documents, projections, aggregation results, keys.
*/
resultsReturned?: string | null;
}
/**
* Explain metrics for the query.
*/
export interface Schema$ExplainMetrics {
/**
* Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.
*/
executionStats?: Schema$ExecutionStats;
/**
* Planning phase information for the query.
*/
planSummary?: Schema$PlanSummary;
}
/**
* Explain options for the query.
*/
export interface Schema$ExplainOptions {
/**
* Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
*/
analyze?: boolean | null;
}
/**
* A holder for any type of filter.
*/
export interface Schema$Filter {
/**
* A composite filter.
*/
compositeFilter?: Schema$CompositeFilter;
/**
* A filter on a property.
*/
propertyFilter?: Schema$PropertyFilter;
}
/**
* Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.
*/
export interface Schema$FindNearest {
/**
* Required. The Distance Measure to use, required.
*/
distanceMeasure?: string | null;
/**
* Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to entity property limitations.
*/
distanceResultProperty?: string | null;
/**
* Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE distance \>= distance_threshold
*/
distanceThreshold?: number | null;
/**
* Required. The number of nearest neighbors to return. Must be a positive integer of no more than 100.
*/
limit?: number | null;
/**
* Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
*/
queryVector?: Schema$Value;
/**
* Required. An indexed vector property to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
*/
vectorProperty?: Schema$PropertyReference;
}
/**
* Metadata common to all Datastore Admin operations.
*/
export interface Schema$GoogleDatastoreAdminV1beta1CommonMetadata {
/**
* The time the operation ended, either successfully or otherwise.
*/
endTime?: string | null;
/**
* The client-assigned labels which were provided when the operation was created. May also include additional labels.
*/
labels?: {[key: string]: string} | null;
/**
* The type of the operation. Can be used as a filter in ListOperationsRequest.
*/
operationType?: string | null;
/**
* The time that work began on the operation.
*/
startTime?: string | null;
/**
* The current state of the Operation.
*/
state?: string | null;
}
/**
* Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']
*/
export interface Schema$GoogleDatastoreAdminV1beta1EntityFilter {
/**
* If empty, then this represents all kinds.
*/
kinds?: string[] | null;
/**
* An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
*/
namespaceIds?: string[] | null;
}
/**
* Metadata for ExportEntities operations.
*/
export interface Schema$GoogleDatastoreAdminV1beta1ExportEntitiesMetadata {
/**
* Metadata common to all Datastore Admin operations.
*/
common?: Schema$GoogleDatastoreAdminV1beta1CommonMetadata;
/**
* Description of which entities are being exported.
*/
entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter;
/**
* Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.
*/
outputUrlPrefix?: string | null;
/**
* An estimate of the number of bytes processed.
*/
progressBytes?: Schema$GoogleDatastoreAdminV1beta1Progress;
/**
* An estimate of the number of entities processed.
*/
progressEntities?: Schema$GoogleDatastoreAdminV1beta1Progress;
}
/**
* The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.
*/
export interface Schema$GoogleDatastoreAdminV1beta1ExportEntitiesResponse {
/**
* Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully.
*/
outputUrl?: string | null;
}
/**
* Metadata for ImportEntities operations.
*/
export interface Schema$GoogleDatastoreAdminV1beta1ImportEntitiesMetadata {
/**
* Metadata common to all Datastore Admin operations.
*/
common?: Schema$GoogleDatastoreAdminV1beta1CommonMetadata;
/**
* Description of which entities are being imported.
*/
entityFilter?: Schema$GoogleDatastoreAdminV1beta1EntityFilter;
/**
* The location of the import metadata file. This will be the same value as the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field.
*/
inputUrl?: string | null;
/**
* An estimate of the number of bytes processed.
*/
progressBytes?: Schema$GoogleDatastoreAdminV1beta1Progress;
/**
* An estimate of the number of entities processed.
*/
progressEntities?: Schema$GoogleDatastoreAdminV1beta1Progress;
}
/**
* Measures the progress of a particular metric.
*/
export interface Schema$GoogleDatastoreAdminV1beta1Progress {
/**
* The amount of work that has been completed. Note that this may be greater than work_estimated.
*/
workCompleted?: string | null;
/**
* An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
*/
workEstimated?: string | null;
}
/**
* Metadata common to all Datastore Admin operations.
*/
export interface Schema$GoogleDatastoreAdminV1CommonMetadata {
/**
* The time the operation ended, either successfully or otherwise.
*/
endTime?: string | null;
/**
* The client-assigned labels which were provided when the operation was created. May also include additional labels.
*/
labels?: {[key: string]: string} | null;
/**
* The type of the operation. Can be used as a filter in ListOperationsRequest.
*/
operationType?: string | null;
/**
* The time that work began on the operation.
*/
startTime?: string | null;
/**
* The current state of the Operation.
*/
state?: string | null;
}
/**
* Metadata for Datastore to Firestore migration operations. The DatastoreFirestoreMigration operation is not started by the end-user via an explicit "creation" method. This is an intentional deviation from the LRO design pattern. This singleton resource can be accessed at: "projects/{project_id\}/operations/datastore-firestore-migration"
*/
export interface Schema$GoogleDatastoreAdminV1DatastoreFirestoreMigrationMetadata {
/**
* The current state of migration from Cloud Datastore to Cloud Firestore in Datastore mode.
*/
migrationState?: string | null;
/**
* The current step of migration from Cloud Datastore to Cloud Firestore in Datastore mode.
*/
migrationStep?: string | null;
}
/**
* Identifies a subset of entities in a project. This is specified as combinations of kinds and namespaces (either or both of which may be all, as described in the following examples). Example usage: Entire project: kinds=[], namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz namespace: kinds=[], namespace_ids=['Baz']
*/
export interface Schema$GoogleDatastoreAdminV1EntityFilter {
/**
* If empty, then this represents all kinds.
*/
kinds?: string[] | null;
/**
* An empty list represents all namespaces. This is the preferred usage for projects that don't use namespaces. An empty string element represents the default namespace. This should be used if the project has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.
*/
namespaceIds?: string[] | null;
}
/**
* Metadata for ExportEntities operations.
*/
export interface Schema$GoogleDatastoreAdminV1ExportEntitiesMetadata {
/**
* Metadata common to all Datastore Admin operations.
*/
common?: Schema$GoogleDatastoreAdminV1CommonMetadata;
/**
* Description of which entities are being exported.
*/
entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter;
/**
* Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url.
*/
outputUrlPrefix?: string | null;
/**
* An estimate of the number of bytes processed.
*/
progressBytes?: Schema$GoogleDatastoreAdminV1Progress;
/**
* An estimate of the number of entities processed.
*/
progressEntities?: Schema$GoogleDatastoreAdminV1Progress;
}
/**
* The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
*/
export interface Schema$GoogleDatastoreAdminV1ExportEntitiesRequest {
/**
* Description of what data from the project is included in the export.
*/
entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter;
/**
* Client-assigned labels.
*/
labels?: {[key: string]: string} | null;
/**
* Required. Location for the export metadata and data files. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace). For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). The resulting files will be nested deeper than the specified URL prefix. The final output URL will be provided in the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That value should be used for subsequent ImportEntities operations. By nesting the data files deeper, the same Cloud Storage bucket can be used in multiple ExportEntities operations without conflict.
*/
outputUrlPrefix?: string | null;
}
/**
* The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities.
*/
export interface Schema$GoogleDatastoreAdminV1ExportEntitiesResponse {
/**
* Location of the output metadata file. This can be used to begin an import into Cloud Datastore (this project or another project). See google.datastore.admin.v1.ImportEntitiesRequest.input_url. Only present if the operation completed successfully.
*/
outputUrl?: string | null;
}
/**
* Metadata for ImportEntities operations.
*/
export interface Schema$GoogleDatastoreAdminV1ImportEntitiesMetadata {
/**
* Metadata common to all Datastore Admin operations.
*/
common?: Schema$GoogleDatastoreAdminV1CommonMetadata;
/**
* Description of which entities are being imported.
*/
entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter;
/**
* The location of the import metadata file. This will be the same value as the google.datastore.admin.v1.ExportEntitiesResponse.output_url field.
*/
inputUrl?: string | null;
/**
* An estimate of the number of bytes processed.
*/
progressBytes?: Schema$GoogleDatastoreAdminV1Progress;
/**
* An estimate of the number of entities processed.
*/
progressEntities?: Schema$GoogleDatastoreAdminV1Progress;
}
/**
* The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities.
*/
export interface Schema$GoogleDatastoreAdminV1ImportEntitiesRequest {
/**
* Optionally specify which kinds/namespaces are to be imported. If provided, the list must be a subset of the EntityFilter used in creating the export, otherwise a FAILED_PRECONDITION error will be returned. If no filter is specified then all entities from the export are imported.
*/
entityFilter?: Schema$GoogleDatastoreAdminV1EntityFilter;
/**
* Required. The full resource URL of the external storage location. Currently, only Google Cloud Storage is supported. So input_url should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a Cloud Datastore namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the ExportEntities operation. For more information about Cloud Storage namespace paths, see [Object name considerations](https://cloud.google.com/storage/docs/naming#object-considerations). For more information, see google.datastore.admin.v1.ExportEntitiesResponse.output_url.
*/
inputUrl?: string | null;
/**
* Client-assigned labels.
*/
labels?: {[key: string]: string} | null;
}
/**
* Datastore composite index definition.
*/
export interface Schema$GoogleDatastoreAdminV1Index {
/**
* Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED.
*/
ancestor?: string | null;
/**
* Output only. The resource ID of the index.
*/
indexId?: string | null;
/**
* Required. The entity kind to which this index applies.
*/
kind?: string | null;
/**
* Output only. Project ID.
*/
projectId?: string | null;
/**
* Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties.
*/
properties?: Schema$GoogleDatastoreAdminV1IndexedProperty[];
/**
* Output only. The state of the index.
*/
state?: string | null;
}
/**
* A property of an index.
*/
export interface Schema$GoogleDatastoreAdminV1IndexedProperty {
/**
* Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED.
*/
direction?: string | null;
/**
* Required. The property name to index.
*/
name?: string | null;
}
/**
* Metadata for Index operations.
*/
export interface Schema$GoogleDatastoreAdminV1IndexOperationMetadata {
/**
* Metadata common to all Datastore Admin operations.
*/
common?: Schema$GoogleDatastoreAdminV1CommonMetadata;
/**
* The index resource ID that this operation is acting on.
*/
indexId?: string | null;
/**
* An estimate of the number of entities processed.
*/
progressEntities?: Schema$GoogleDatastoreAdminV1Progress;
}
/**
* The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes.
*/
export interface Schema$GoogleDatastoreAdminV1ListIndexesResponse {
/**
* The indexes.
*/
indexes?: Schema$GoogleDatastoreAdminV1Index[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* An event signifying the start of a new step in a [migration from Cloud Datastore to Cloud Firestore in Datastore mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
*/
export interface Schema$GoogleDatastoreAdminV1MigrationProgressEvent {
/**
* Details for the `PREPARE` step.
*/
prepareStepDetails?: Schema$GoogleDatastoreAdminV1PrepareStepDetails;
/**
* Details for the `REDIRECT_WRITES` step.
*/
redirectWritesStepDetails?: Schema$GoogleDatastoreAdminV1RedirectWritesStepDetails;
/**
* The step that is starting. An event with step set to `START` indicates that the migration has been reverted back to the initial pre-migration state.
*/
step?: string | null;
}
/**
* An event signifying a change in state of a [migration from Cloud Datastore to Cloud Firestore in Datastore mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
*/
export interface Schema$GoogleDatastoreAdminV1MigrationStateEvent {
/**
* The new state of the migration.
*/
state?: string | null;
}
/**
* Details for the `PREPARE` step.
*/
export interface Schema$GoogleDatastoreAdminV1PrepareStepDetails {
/**
* The concurrency mode this database will use when it reaches the `REDIRECT_WRITES` step.
*/
concurrencyMode?: string | null;
}
/**
* Measures the progress of a particular metric.
*/
export interface Schema$GoogleDatastoreAdminV1Progress {
/**
* The amount of work that has been completed. Note that this may be greater than work_estimated.
*/
workCompleted?: string | null;
/**
* An estimate of how much work needs to be performed. May be zero if the work estimate is unavailable.
*/
workEstimated?: string | null;
}
/**
* Details for the `REDIRECT_WRITES` step.
*/
export interface Schema$GoogleDatastoreAdminV1RedirectWritesStepDetails {
/**
* The concurrency mode for this database.
*/
concurrencyMode?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$GoogleLongrunningListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$GoogleLongrunningOperation[];
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$GoogleLongrunningOperation {
/**
* If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
*/
metadata?: {[key: string]: any} | null;
/**
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
*/
name?: string | null;
/**
* The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {[key: string]: any} | null;
}
/**
* A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
*/
export interface Schema$GqlQuery {
/**
* 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.
*/
allowLiterals?: boolean | null;
/**
* 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_$*`, must not match regex `__.*__`, and must not be `""`.
*/
namedBindings?: {[key: string]: Schema$GqlQueryParameter} | null;
/**
* 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.
*/
positionalBindings?: Schema$GqlQueryParameter[];
/**
* A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
*/
queryString?: string | null;
}
/**
* A binding parameter for a GQL query.
*/
export interface Schema$GqlQueryParameter {
/**
* A query cursor. Query cursors are returned in query result batches.
*/
cursor?: string | null;
/**
* A value parameter.
*/
value?: Schema$Value;
}
/**
* A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts.
*/
export interface Schema$Key {
/**
* Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition.
*/
partitionId?: Schema$PartitionId;
/**
* The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements.
*/
path?: Schema$PathElement[];
}
/**
* A representation of a kind.
*/
export interface Schema$KindExpression {
/**
* The name of the kind.
*/
name?: string | null;
}
/**
* An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
*/
export interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number | null;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number | null;
}
/**
* The request for Datastore.Lookup.
*/
export interface Schema$LookupRequest {
/**
* The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.
*/
databaseId?: string | null;
/**
* Required. Keys of entities to look up.
*/
keys?: Schema$Key[];
/**
* The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity's key is always returned.
*/
propertyMask?: Schema$PropertyMask;
/**
* The options for this lookup request.
*/
readOptions?: Schema$ReadOptions;
}
/**
* The response for Datastore.Lookup.
*/
export interface Schema$LookupResponse {
/**
* A list of keys that were not looked up due to resource constraints. The order of results in this field is undefined and has no relation to the order of the keys in the input.
*/
deferred?: Schema$Key[];
/**
* Entities found as `ResultType.FULL` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.
*/
found?: Schema$EntityResult[];
/**
* Entities not found as `ResultType.KEY_ONLY` entities. The order of results in this field is undefined and has no relation to the order of the keys in the input.
*/
missing?: Schema$EntityResult[];
/**
* The time at which these entities were read or found missing.
*/
readTime?: string | null;
/**
* The identifier of the transaction that was started as part of this Lookup request. Set only when ReadOptions.new_transaction was set in LookupRequest.read_options.
*/
transaction?: string | null;
}
/**
* A mutation to apply to an entity.
*/
export interface Schema$Mutation {
/**
* The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.
*/
baseVersion?: string | null;
/**
* The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`. If this is set, then `conflict_detection_strategy` must also be set.
*/
conflictResolutionStrategy?: string | null;
/**
* The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.
*/
delete?: Schema$Key;
/**
* The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.
*/
insert?: Schema$Entity;
/**
* The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted.
*/
propertyMask?: Schema$PropertyMask;
/**
* Optional. The transforms to perform on the entity. This field can be set only when the operation is `insert`, `update`, or `upsert`. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation.
*/
propertyTransforms?: Schema$PropertyTransform[];
/**
* The entity to update. The entity must already exist. Must have a complete key path.
*/
update?: Schema$Entity;
/**
* The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts.
*/
updateTime?: string | null;
/**
* The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.
*/
upsert?: Schema$Entity;
}
/**
* The result of applying a mutation.
*/
export interface Schema$MutationResult {
/**
* Whether a conflict was detected for this mutation. Always false when a conflict detection strategy field is not set in the mutation.
*/
conflictDetected?: boolean | null;
/**
* The create time of the entity. This field will not be set after a 'delete'.
*/
createTime?: string | null;
/**
* The automatically allocated key. Set only when the mutation allocated a key.
*/
key?: Schema$Key;
/**
* The results of applying each PropertyTransform, in the same order of the request.
*/
transformResults?: Schema$Value[];
/**
* The update time of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the timestamp will be the update timestamp of the current entity. This field will not be set after a 'delete'.
*/
updateTime?: string | null;
/**
* The version of the entity on the server after processing the mutation. If the mutation doesn't change anything on the server, then the version will be the version of the current entity or, if no entity is present, a version that is strictly greater than the version of any previous entity and less than the version of any possible future entity.
*/
version?: string | null;
}
/**
* A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100\}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state.
*/
export interface Schema$PartitionId {
/**
* If not empty, the ID of the database to which the entities belong.
*/
databaseId?: string | null;
/**
* If not empty, the ID of the namespace to which the entities belong.
*/
namespaceId?: string | null;
/**
* The ID of the project to which the entities belong.
*/
projectId?: string | null;
}
/**
* A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete.
*/
export interface Schema$PathElement {
/**
* The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future.
*/
id?: string | null;
/**
* The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes.
*/
kind?: string | null;
/**
* The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes.
*/
name?: string | null;
}
/**
* Planning phase information for the query.
*/
export interface Schema$PlanSummary {
/**
* The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"\}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"\} ]
*/
indexesUsed?: Array<{[key: string]: any}> | null;
}
/**
* A representation of a property in a projection.
*/
export interface Schema$Projection {
/**
* The property to project.
*/
property?: Schema$PropertyReference;
}
/**
* A filter on a specific property.
*/
export interface Schema$PropertyFilter {
/**
* The operator to filter by.
*/
op?: string | null;
/**
* The property to filter by.
*/
property?: Schema$PropertyReference;
/**
* The value to compare the property to.
*/
value?: Schema$Value;
}
/**
* The set of arbitrarily nested property paths used to restrict an operation to only a subset of properties in an entity.
*/
export interface Schema$PropertyMask {
/**
* The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value.
*/
paths?: string[] | null;
}
/**
* The desired order for a specific property.
*/
export interface Schema$PropertyOrder {
/**
* The direction to order by. Defaults to `ASCENDING`.
*/
direction?: string | null;
/**
* The property to order by.
*/
property?: Schema$PropertyReference;
}
/**
* A reference to a property relative to the kind expressions.
*/
export interface Schema$PropertyReference {
/**
* A reference to a property. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to entity property name limitations.
*/
name?: string | null;
}
/**
* A transformation of an entity property.
*/
export interface Schema$PropertyTransform {
/**
* Appends the given elements in order if they are not already present in the current property value. If the property is not an array, or if the property does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and the null value is equal to the null value. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform result will be the null value.
*/
appendMissingElements?: Schema$ArrayValue;
/**
* Adds the given value to the property's current value. This must be an integer or a double value. If the property is not an integer or double, or if the property does not yet exist, the transformation will set the property to the given value. If either of the given value or the current property value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follows IEEE 754 semantics. If there is positive/negative