com.google.firestore.v1.TargetChangeOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-firestore-v1 Show documentation
PROTO library for proto-google-cloud-firestore-v1
There is a newer version: 3.29.1
Show newest version
/*
 * Copyright 2024 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/firestore/v1/firestore.proto

// Protobuf Java Version: 3.25.4
package com.google.firestore.v1;

public interface TargetChangeOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.firestore.v1.TargetChange)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The type of change that occurred.
   * 
   *
   * .google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;
   *
   * @return The enum numeric value on the wire for targetChangeType.
   */
  int getTargetChangeTypeValue();
  /**
   *
   *
   *    * The type of change that occurred.
   * 
   *
   * .google.firestore.v1.TargetChange.TargetChangeType target_change_type = 1;
   *
   * @return The targetChangeType.
   */
  com.google.firestore.v1.TargetChange.TargetChangeType getTargetChangeType();

  /**
   *
   *
   *    * The target IDs of targets that have changed.
   *
   * If empty, the change applies to all targets.
   *
   * The order of the target IDs is not defined.
   * 
   *
   * repeated int32 target_ids = 2;
   *
   * @return A list containing the targetIds.
   */
  java.util.List getTargetIdsList();
  /**
   *
   *
   *    * The target IDs of targets that have changed.
   *
   * If empty, the change applies to all targets.
   *
   * The order of the target IDs is not defined.
   * 
   *
   * repeated int32 target_ids = 2;
   *
   * @return The count of targetIds.
   */
  int getTargetIdsCount();
  /**
   *
   *
   *    * The target IDs of targets that have changed.
   *
   * If empty, the change applies to all targets.
   *
   * The order of the target IDs is not defined.
   * 
   *
   * repeated int32 target_ids = 2;
   *
   * @param index The index of the element to return.
   * @return The targetIds at the given index.
   */
  int getTargetIds(int index);

  /**
   *
   *
   *    * The error that resulted in this change, if applicable.
   * 
   *
   * .google.rpc.Status cause = 3;
   *
   * @return Whether the cause field is set.
   */
  boolean hasCause();
  /**
   *
   *
   *    * The error that resulted in this change, if applicable.
   * 
   *
   * .google.rpc.Status cause = 3;
   *
   * @return The cause.
   */
  com.google.rpc.Status getCause();
  /**
   *
   *
   *    * The error that resulted in this change, if applicable.
   * 
   *
   * .google.rpc.Status cause = 3;
   */
  com.google.rpc.StatusOrBuilder getCauseOrBuilder();

  /**
   *
   *
   *    * A token that can be used to resume the stream for the given `target_ids`,
   * or all targets if `target_ids` is empty.
   *
   * Not set on every target change.
   * 
   *
   * bytes resume_token = 4;
   *
   * @return The resumeToken.
   */
  com.google.protobuf.ByteString getResumeToken();

  /**
   *
   *
   *    * The consistent `read_time` for the given `target_ids` (omitted when the
   * target_ids are not at a consistent snapshot).
   *
   * The stream is guaranteed to send a `read_time` with `target_ids` empty
   * whenever the entire stream reaches a new consistent snapshot. ADD,
   * CURRENT, and RESET messages are guaranteed to (eventually) result in a
   * new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
   *
   * For a given stream, `read_time` is guaranteed to be monotonically
   * increasing.
   * 
   *
   * .google.protobuf.Timestamp read_time = 6;
   *
   * @return Whether the readTime field is set.
   */
  boolean hasReadTime();
  /**
   *
   *
   *    * The consistent `read_time` for the given `target_ids` (omitted when the
   * target_ids are not at a consistent snapshot).
   *
   * The stream is guaranteed to send a `read_time` with `target_ids` empty
   * whenever the entire stream reaches a new consistent snapshot. ADD,
   * CURRENT, and RESET messages are guaranteed to (eventually) result in a
   * new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
   *
   * For a given stream, `read_time` is guaranteed to be monotonically
   * increasing.
   * 
   *
   * .google.protobuf.Timestamp read_time = 6;
   *
   * @return The readTime.
   */
  com.google.protobuf.Timestamp getReadTime();
  /**
   *
   *
   *    * The consistent `read_time` for the given `target_ids` (omitted when the
   * target_ids are not at a consistent snapshot).
   *
   * The stream is guaranteed to send a `read_time` with `target_ids` empty
   * whenever the entire stream reaches a new consistent snapshot. ADD,
   * CURRENT, and RESET messages are guaranteed to (eventually) result in a
   * new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
   *
   * For a given stream, `read_time` is guaranteed to be monotonically
   * increasing.
   * 
   *
   * .google.protobuf.Timestamp read_time = 6;
   */
  com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();
}