com.google.pubsub.v1.SnapshotOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-pubsub-v1 Show documentation
Show all versions of proto-google-cloud-pubsub-v1 Show documentation
PROTO library for proto-google-cloud-pubsub-v1
/*
* 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.3
package com.google.pubsub.v1;
public interface SnapshotOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.pubsub.v1.Snapshot)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Optional. The name of the snapshot.
*
*
* string name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Optional. The name of the snapshot.
*
*
* string name = 1 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Optional. The name of the topic from which this snapshot is retaining
* messages.
*
*
*
* string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The topic.
*/
java.lang.String getTopic();
/**
*
*
*
* Optional. The name of the topic from which this snapshot is retaining
* messages.
*
*
*
* string topic = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for topic.
*/
com.google.protobuf.ByteString getTopicBytes();
/**
*
*
*
* Optional. The snapshot is guaranteed to exist up until this time.
* A newly-created snapshot expires no later than 7 days from the time of its
* creation. Its exact lifetime is determined at creation by the existing
* backlog in the source subscription. Specifically, the lifetime of the
* snapshot is `7 days - (age of oldest unacked message in the subscription)`.
* For example, consider a subscription whose oldest unacked message is 3 days
* old. If a snapshot is created from this subscription, the snapshot -- which
* will always capture this 3-day-old backlog as long as the snapshot
* exists -- will expire in 4 days. The service will refuse to create a
* snapshot that would expire in less than 1 hour after creation.
*
*
* .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the expireTime field is set.
*/
boolean hasExpireTime();
/**
*
*
*
* Optional. The snapshot is guaranteed to exist up until this time.
* A newly-created snapshot expires no later than 7 days from the time of its
* creation. Its exact lifetime is determined at creation by the existing
* backlog in the source subscription. Specifically, the lifetime of the
* snapshot is `7 days - (age of oldest unacked message in the subscription)`.
* For example, consider a subscription whose oldest unacked message is 3 days
* old. If a snapshot is created from this subscription, the snapshot -- which
* will always capture this 3-day-old backlog as long as the snapshot
* exists -- will expire in 4 days. The service will refuse to create a
* snapshot that would expire in less than 1 hour after creation.
*
*
* .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The expireTime.
*/
com.google.protobuf.Timestamp getExpireTime();
/**
*
*
*
* Optional. The snapshot is guaranteed to exist up until this time.
* A newly-created snapshot expires no later than 7 days from the time of its
* creation. Its exact lifetime is determined at creation by the existing
* backlog in the source subscription. Specifically, the lifetime of the
* snapshot is `7 days - (age of oldest unacked message in the subscription)`.
* For example, consider a subscription whose oldest unacked message is 3 days
* old. If a snapshot is created from this subscription, the snapshot -- which
* will always capture this 3-day-old backlog as long as the snapshot
* exists -- will expire in 4 days. The service will refuse to create a
* snapshot that would expire in less than 1 hour after creation.
*
*
* .google.protobuf.Timestamp expire_time = 3 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder();
/**
*
*
*
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
*
* map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
}