/*
* 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/pubsub/v1/pubsub.proto
// Protobuf Java Version: 3.25.5
package com.google.pubsub.v1;
public interface SeekRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.pubsub.v1.SeekRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. The subscription to affect.
*
*
*
* string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The subscription.
*/
java.lang.String getSubscription();
/**
*
*
*
* Required. The subscription to affect.
*
*
*
* string subscription = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for subscription.
*/
com.google.protobuf.ByteString getSubscriptionBytes();
/**
*
*
*
* Optional. The time to seek to.
* Messages retained in the subscription that were published before this
* time are marked as acknowledged, and messages retained in the
* subscription that were published after this time are marked as
* unacknowledged. Note that this operation affects only those messages
* retained in the subscription (configured by the combination of
* `message_retention_duration` and `retain_acked_messages`). For example,
* if `time` corresponds to a point before the message retention
* window (or to a point before the system's notion of the subscription
* creation time), only retained messages will be marked as unacknowledged,
* and already-expunged messages will not be restored.
*
*
* .google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the time field is set.
*/
boolean hasTime();
/**
*
*
*
* Optional. The time to seek to.
* Messages retained in the subscription that were published before this
* time are marked as acknowledged, and messages retained in the
* subscription that were published after this time are marked as
* unacknowledged. Note that this operation affects only those messages
* retained in the subscription (configured by the combination of
* `message_retention_duration` and `retain_acked_messages`). For example,
* if `time` corresponds to a point before the message retention
* window (or to a point before the system's notion of the subscription
* creation time), only retained messages will be marked as unacknowledged,
* and already-expunged messages will not be restored.
*
*
* .google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The time.
*/
com.google.protobuf.Timestamp getTime();
/**
*
*
*
* Optional. The time to seek to.
* Messages retained in the subscription that were published before this
* time are marked as acknowledged, and messages retained in the
* subscription that were published after this time are marked as
* unacknowledged. Note that this operation affects only those messages
* retained in the subscription (configured by the combination of
* `message_retention_duration` and `retain_acked_messages`). For example,
* if `time` corresponds to a point before the message retention
* window (or to a point before the system's notion of the subscription
* creation time), only retained messages will be marked as unacknowledged,
* and already-expunged messages will not be restored.
*
*
* .google.protobuf.Timestamp time = 2 [(.google.api.field_behavior) = OPTIONAL];
*/
com.google.protobuf.TimestampOrBuilder getTimeOrBuilder();
/**
*
*
*
* Optional. The snapshot to seek to. The snapshot's topic must be the same
* as that of the provided subscription. Format is
* `projects/{project}/snapshots/{snap}`.
*
*
*
* string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return Whether the snapshot field is set.
*/
boolean hasSnapshot();
/**
*
*
*
* Optional. The snapshot to seek to. The snapshot's topic must be the same
* as that of the provided subscription. Format is
* `projects/{project}/snapshots/{snap}`.
*
*
*
* string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The snapshot.
*/
java.lang.String getSnapshot();
/**
*
*
*
* Optional. The snapshot to seek to. The snapshot's topic must be the same
* as that of the provided subscription. Format is
* `projects/{project}/snapshots/{snap}`.
*
*
*
* string snapshot = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for snapshot.
*/
com.google.protobuf.ByteString getSnapshotBytes();
com.google.pubsub.v1.SeekRequest.TargetCase getTargetCase();
}
