@google-cloud/firestore-api 0.4.0 → 0.5.0

package/build/protos/google/firestore/v1/common.proto

@@ -109,3 +109,10 @@ message TransactionOptions {
     ReadWrite read_write = 3;
   }
 }
+
+// Options for a server request.
+message RequestOptions {
+  // The request tags for the request.
+  repeated string request_tags = 1 [(google.api.field_behavior) = OPTIONAL];
+}
+

package/build/protos/google/firestore/v1/firestore.proto

@@ -285,6 +285,9 @@ message GetDocumentRequest {
     // minute timestamp within the past 7 days.
     google.protobuf.Timestamp read_time = 5;
   }
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 10 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for
@@ -358,6 +361,9 @@ message ListDocumentsRequest {
   //
   // Requests with `show_missing` may not specify `where` or `order_by`.
   bool show_missing = 12;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 13 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for
@@ -397,6 +403,9 @@ message CreateDocumentRequest {
   // If the document has a field that is not present in this mask, that field
   // will not be returned in the response.
   DocumentMask mask = 5;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 6 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for
@@ -424,6 +433,9 @@ message UpdateDocumentRequest {
   // An optional precondition on the document.
   // The request will fail if this is set and not met by the target document.
   Precondition current_document = 4;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for
@@ -436,6 +448,9 @@ message DeleteDocumentRequest {
   // An optional precondition on the document.
   // The request will fail if this is set and not met by the target document.
   Precondition current_document = 2;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for
@@ -476,6 +491,9 @@ message BatchGetDocumentsRequest {
     // minute timestamp within the past 7 days.
     google.protobuf.Timestamp read_time = 7;
   }
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 8 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The streamed response for
@@ -515,6 +533,9 @@ message BeginTransactionRequest {
   // The options for the transaction.
   // Defaults to a read-write transaction.
   TransactionOptions options = 2;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for
@@ -537,6 +558,9 @@ message CommitRequest {
 
   // If set, applies all writes in this transaction, and commits it.
   bytes transaction = 3;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for [Firestore.Commit][google.firestore.v1.Firestore.Commit].
@@ -560,6 +584,9 @@ message RollbackRequest {
 
   // Required. The transaction to roll back.
   bytes transaction = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 3 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
@@ -603,6 +630,9 @@ message RunQueryRequest {
   // Optional. Explain options for the query. If set, additional query
   // statistics will be returned. If not, only query results will be returned.
   ExplainOptions explain_options = 10 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 11 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for
@@ -683,6 +713,9 @@ message ExecutePipelineRequest {
   // executed. Only permitted in combination with `transaction` or
   // `new_transaction`.
   bool auto_commit_transaction = 9 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 10 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for [Firestore.Execute][].
@@ -771,6 +804,9 @@ message RunAggregationQueryRequest {
   // Optional. Explain options for the query. If set, additional query
   // statistics will be returned. If not, only query results will be returned.
   ExplainOptions explain_options = 8 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 9 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for
@@ -865,6 +901,9 @@ message PartitionQueryRequest {
     // minute timestamp within the past 7 days.
     google.protobuf.Timestamp read_time = 6;
   }
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 7 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for
@@ -942,6 +981,9 @@ message WriteRequest {
 
   // Labels associated with this write request.
   map<string, string> labels = 5;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 6 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for [Firestore.Write][google.firestore.v1.Firestore.Write].
@@ -984,6 +1026,9 @@ message ListenRequest {
 
   // Labels associated with this target change.
   map<string, string> labels = 4;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response for [Firestore.Listen][google.firestore.v1.Firestore.Listen].
@@ -1190,6 +1235,9 @@ message ListCollectionIdsRequest {
     // minute timestamp within the past 7 days.
     google.protobuf.Timestamp read_time = 4;
   }
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 5 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response from
@@ -1218,6 +1266,9 @@ message BatchWriteRequest {
 
   // Labels associated with this batch write.
   map<string, string> labels = 3;
+
+  // Optional. Any additional options for the request.
+  RequestOptions request_options = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // The response from

package/build/protos/protos.d.ts

@@ -11421,6 +11421,103 @@ export namespace google {
                 }
             }
 
+            /** Properties of a RequestOptions. */
+            interface IRequestOptions {
+
+                /** RequestOptions requestTags */
+                requestTags?: (string[]|null);
+            }
+
+            /** Represents a RequestOptions. */
+            class RequestOptions implements IRequestOptions {
+
+                /**
+                 * Constructs a new RequestOptions.
+                 * @param [properties] Properties to set
+                 */
+                constructor(properties?: google.firestore.v1.IRequestOptions);
+
+                /** RequestOptions requestTags. */
+                public requestTags: string[];
+
+                /**
+                 * Creates a new RequestOptions instance using the specified properties.
+                 * @param [properties] Properties to set
+                 * @returns RequestOptions instance
+                 */
+                public static create(properties?: google.firestore.v1.IRequestOptions): google.firestore.v1.RequestOptions;
+
+                /**
+                 * Encodes the specified RequestOptions message. Does not implicitly {@link google.firestore.v1.RequestOptions.verify|verify} messages.
+                 * @param message RequestOptions message or plain object to encode
+                 * @param [writer] Writer to encode to
+                 * @returns Writer
+                 */
+                public static encode(message: google.firestore.v1.IRequestOptions, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                /**
+                 * Encodes the specified RequestOptions message, length delimited. Does not implicitly {@link google.firestore.v1.RequestOptions.verify|verify} messages.
+                 * @param message RequestOptions message or plain object to encode
+                 * @param [writer] Writer to encode to
+                 * @returns Writer
+                 */
+                public static encodeDelimited(message: google.firestore.v1.IRequestOptions, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                /**
+                 * Decodes a RequestOptions message from the specified reader or buffer.
+                 * @param reader Reader or buffer to decode from
+                 * @param [length] Message length if known beforehand
+                 * @returns RequestOptions
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.firestore.v1.RequestOptions;
+
+                /**
+                 * Decodes a RequestOptions message from the specified reader or buffer, length delimited.
+                 * @param reader Reader or buffer to decode from
+                 * @returns RequestOptions
+                 * @throws {Error} If the payload is not a reader or valid buffer
+                 * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                 */
+                public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.firestore.v1.RequestOptions;
+
+                /**
+                 * Verifies a RequestOptions message.
+                 * @param message Plain object to verify
+                 * @returns `null` if valid, otherwise the reason why it is not
+                 */
+                public static verify(message: { [k: string]: any }): (string|null);
+
+                /**
+                 * Creates a RequestOptions message from a plain object. Also converts values to their respective internal types.
+                 * @param object Plain object
+                 * @returns RequestOptions
+                 */
+                public static fromObject(object: { [k: string]: any }): google.firestore.v1.RequestOptions;
+
+                /**
+                 * Creates a plain object from a RequestOptions message. Also converts values to other types if specified.
+                 * @param message RequestOptions
+                 * @param [options] Conversion options
+                 * @returns Plain object
+                 */
+                public static toObject(message: google.firestore.v1.RequestOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                /**
+                 * Converts this RequestOptions to JSON.
+                 * @returns JSON object
+                 */
+                public toJSON(): { [k: string]: any };
+
+                /**
+                 * Gets the default type url for RequestOptions
+                 * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                 * @returns The default type url
+                 */
+                public static getTypeUrl(typeUrlPrefix?: string): string;
+            }
+
             /** Properties of an ExplainStats. */
             interface IExplainStats {
 
@@ -11913,6 +12010,9 @@ export namespace google {
 
                 /** GetDocumentRequest readTime */
                 readTime?: (google.protobuf.ITimestamp|null);
+
+                /** GetDocumentRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a GetDocumentRequest. */
@@ -11936,6 +12036,9 @@ export namespace google {
                 /** GetDocumentRequest readTime. */
                 public readTime?: (google.protobuf.ITimestamp|null);
 
+                /** GetDocumentRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** GetDocumentRequest consistencySelector. */
                 public consistencySelector?: ("transaction"|"readTime");
 
@@ -12046,6 +12149,9 @@ export namespace google {
 
                 /** ListDocumentsRequest showMissing */
                 showMissing?: (boolean|null);
+
+                /** ListDocumentsRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a ListDocumentsRequest. */
@@ -12084,6 +12190,9 @@ export namespace google {
                 /** ListDocumentsRequest showMissing. */
                 public showMissing: boolean;
 
+                /** ListDocumentsRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** ListDocumentsRequest consistencySelector. */
                 public consistencySelector?: ("transaction"|"readTime");
 
@@ -12285,6 +12394,9 @@ export namespace google {
 
                 /** CreateDocumentRequest mask */
                 mask?: (google.firestore.v1.IDocumentMask|null);
+
+                /** CreateDocumentRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a CreateDocumentRequest. */
@@ -12311,6 +12423,9 @@ export namespace google {
                 /** CreateDocumentRequest mask. */
                 public mask?: (google.firestore.v1.IDocumentMask|null);
 
+                /** CreateDocumentRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new CreateDocumentRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -12403,6 +12518,9 @@ export namespace google {
 
                 /** UpdateDocumentRequest currentDocument */
                 currentDocument?: (google.firestore.v1.IPrecondition|null);
+
+                /** UpdateDocumentRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents an UpdateDocumentRequest. */
@@ -12426,6 +12544,9 @@ export namespace google {
                 /** UpdateDocumentRequest currentDocument. */
                 public currentDocument?: (google.firestore.v1.IPrecondition|null);
 
+                /** UpdateDocumentRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new UpdateDocumentRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -12512,6 +12633,9 @@ export namespace google {
 
                 /** DeleteDocumentRequest currentDocument */
                 currentDocument?: (google.firestore.v1.IPrecondition|null);
+
+                /** DeleteDocumentRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a DeleteDocumentRequest. */
@@ -12529,6 +12653,9 @@ export namespace google {
                 /** DeleteDocumentRequest currentDocument. */
                 public currentDocument?: (google.firestore.v1.IPrecondition|null);
 
+                /** DeleteDocumentRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new DeleteDocumentRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -12627,6 +12754,9 @@ export namespace google {
 
                 /** BatchGetDocumentsRequest readTime */
                 readTime?: (google.protobuf.ITimestamp|null);
+
+                /** BatchGetDocumentsRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a BatchGetDocumentsRequest. */
@@ -12656,6 +12786,9 @@ export namespace google {
                 /** BatchGetDocumentsRequest readTime. */
                 public readTime?: (google.protobuf.ITimestamp|null);
 
+                /** BatchGetDocumentsRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** BatchGetDocumentsRequest consistencySelector. */
                 public consistencySelector?: ("transaction"|"newTransaction"|"readTime");
 
@@ -12863,6 +12996,9 @@ export namespace google {
 
                 /** BeginTransactionRequest options */
                 options?: (google.firestore.v1.ITransactionOptions|null);
+
+                /** BeginTransactionRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a BeginTransactionRequest. */
@@ -12880,6 +13016,9 @@ export namespace google {
                 /** BeginTransactionRequest options. */
                 public options?: (google.firestore.v1.ITransactionOptions|null);
 
+                /** BeginTransactionRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new BeginTransactionRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -13066,6 +13205,9 @@ export namespace google {
 
                 /** CommitRequest transaction */
                 transaction?: (Uint8Array|Buffer|string|null);
+
+                /** CommitRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a CommitRequest. */
@@ -13086,6 +13228,9 @@ export namespace google {
                 /** CommitRequest transaction. */
                 public transaction: (Uint8Array|Buffer|string);
 
+                /** CommitRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new CommitRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -13275,6 +13420,9 @@ export namespace google {
 
                 /** RollbackRequest transaction */
                 transaction?: (Uint8Array|Buffer|string|null);
+
+                /** RollbackRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a RollbackRequest. */
@@ -13292,6 +13440,9 @@ export namespace google {
                 /** RollbackRequest transaction. */
                 public transaction: (Uint8Array|Buffer|string);
 
+                /** RollbackRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new RollbackRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -13390,6 +13541,9 @@ export namespace google {
 
                 /** RunQueryRequest explainOptions */
                 explainOptions?: (google.firestore.v1.IExplainOptions|null);
+
+                /** RunQueryRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a RunQueryRequest. */
@@ -13419,6 +13573,9 @@ export namespace google {
                 /** RunQueryRequest explainOptions. */
                 public explainOptions?: (google.firestore.v1.IExplainOptions|null);
 
+                /** RunQueryRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** RunQueryRequest queryType. */
                 public queryType?: "structuredQuery";
 
@@ -13653,6 +13810,9 @@ export namespace google {
 
                 /** ExecutePipelineRequest autoCommitTransaction */
                 autoCommitTransaction?: (boolean|null);
+
+                /** ExecutePipelineRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents an ExecutePipelineRequest. */
@@ -13682,6 +13842,9 @@ export namespace google {
                 /** ExecutePipelineRequest autoCommitTransaction. */
                 public autoCommitTransaction: boolean;
 
+                /** ExecutePipelineRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** ExecutePipelineRequest pipelineType. */
                 public pipelineType?: "structuredPipeline";
 
@@ -13901,6 +14064,9 @@ export namespace google {
 
                 /** RunAggregationQueryRequest explainOptions */
                 explainOptions?: (google.firestore.v1.IExplainOptions|null);
+
+                /** RunAggregationQueryRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a RunAggregationQueryRequest. */
@@ -13930,6 +14096,9 @@ export namespace google {
                 /** RunAggregationQueryRequest explainOptions. */
                 public explainOptions?: (google.firestore.v1.IExplainOptions|null);
 
+                /** RunAggregationQueryRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** RunAggregationQueryRequest queryType. */
                 public queryType?: "structuredAggregationQuery";
 
@@ -14149,6 +14318,9 @@ export namespace google {
 
                 /** PartitionQueryRequest readTime */
                 readTime?: (google.protobuf.ITimestamp|null);
+
+                /** PartitionQueryRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a PartitionQueryRequest. */
@@ -14178,6 +14350,9 @@ export namespace google {
                 /** PartitionQueryRequest readTime. */
                 public readTime?: (google.protobuf.ITimestamp|null);
 
+                /** PartitionQueryRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** PartitionQueryRequest queryType. */
                 public queryType?: "structuredQuery";
 
@@ -14382,6 +14557,9 @@ export namespace google {
 
                 /** WriteRequest labels */
                 labels?: ({ [k: string]: string }|null);
+
+                /** WriteRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a WriteRequest. */
@@ -14408,6 +14586,9 @@ export namespace google {
                 /** WriteRequest labels. */
                 public labels: { [k: string]: string };
 
+                /** WriteRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new WriteRequest instance using the specified properties.
                  * @param [properties] Properties to set
@@ -14615,6 +14796,9 @@ export namespace google {
 
                 /** ListenRequest labels */
                 labels?: ({ [k: string]: string }|null);
+
+                /** ListenRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a ListenRequest. */
@@ -14638,6 +14822,9 @@ export namespace google {
                 /** ListenRequest labels. */
                 public labels: { [k: string]: string };
 
+                /** ListenRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** ListenRequest targetChange. */
                 public targetChange?: ("addTarget"|"removeTarget");
 
@@ -15335,6 +15522,9 @@ export namespace google {
 
                 /** ListCollectionIdsRequest readTime */
                 readTime?: (google.protobuf.ITimestamp|null);
+
+                /** ListCollectionIdsRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a ListCollectionIdsRequest. */
@@ -15358,6 +15548,9 @@ export namespace google {
                 /** ListCollectionIdsRequest readTime. */
                 public readTime?: (google.protobuf.ITimestamp|null);
 
+                /** ListCollectionIdsRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /** ListCollectionIdsRequest consistencySelector. */
                 public consistencySelector?: "readTime";
 
@@ -15553,6 +15746,9 @@ export namespace google {
 
                 /** BatchWriteRequest labels */
                 labels?: ({ [k: string]: string }|null);
+
+                /** BatchWriteRequest requestOptions */
+                requestOptions?: (google.firestore.v1.IRequestOptions|null);
             }
 
             /** Represents a BatchWriteRequest. */
@@ -15573,6 +15769,9 @@ export namespace google {
                 /** BatchWriteRequest labels. */
                 public labels: { [k: string]: string };
 
+                /** BatchWriteRequest requestOptions. */
+                public requestOptions?: (google.firestore.v1.IRequestOptions|null);
+
                 /**
                  * Creates a new BatchWriteRequest instance using the specified properties.
                  * @param [properties] Properties to set