Package com.google.pubsub.v1
Class Topic
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.pubsub.v1.Topic
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,TopicOrBuilder
,Serializable
A topic resource.Protobuf type
google.pubsub.v1.Topic
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsLabels
(String key) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).boolean
static Topic
static final com.google.protobuf.Descriptors.Descriptor
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.com.google.protobuf.ByteString
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.Deprecated.int
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).getLabelsOrDefault
(String key, String defaultValue) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).getLabelsOrThrow
(String key) See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).com.google.protobuf.Duration
Indicates the minimum duration to retain a message after it is published to the topic.com.google.protobuf.DurationOrBuilder
Indicates the minimum duration to retain a message after it is published to the topic.Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.getName()
Required.com.google.protobuf.ByteString
Required.com.google.protobuf.Parser<Topic>
boolean
Reserved for future use.Settings for validating messages published against a schema.Settings for validating messages published against a schema.int
int
hashCode()
boolean
Indicates the minimum duration to retain a message after it is published to the topic.boolean
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored.boolean
Settings for validating messages published against a schema.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
protected com.google.protobuf.MapField
internalGetMapField
(int number) final boolean
static Topic.Builder
static Topic.Builder
newBuilder
(Topic prototype) protected Topic.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static Topic
parseDelimitedFrom
(InputStream input) static Topic
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Topic
parseFrom
(byte[] data) static Topic
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Topic
parseFrom
(com.google.protobuf.ByteString data) static Topic
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Topic
parseFrom
(com.google.protobuf.CodedInputStream input) static Topic
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Topic
parseFrom
(InputStream input) static Topic
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Topic
parseFrom
(ByteBuffer data) static Topic
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Topic>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
public static final int MESSAGE_STORAGE_POLICY_FIELD_NUMBER- See Also:
-
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER- See Also:
-
SCHEMA_SETTINGS_FIELD_NUMBER
public static final int SCHEMA_SETTINGS_FIELD_NUMBER- See Also:
-
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER- See Also:
-
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number) - Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getName
Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getName
in interfaceTopicOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getNameBytes
in interfaceTopicOrBuilder
- Returns:
- The bytes for name.
-
getLabelsCount
public int getLabelsCount()Description copied from interface:TopicOrBuilder
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 2;
- Specified by:
getLabelsCount
in interfaceTopicOrBuilder
-
containsLabels
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 2;
- Specified by:
containsLabels
in interfaceTopicOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceTopicOrBuilder
-
getLabelsMap
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 2;
- Specified by:
getLabelsMap
in interfaceTopicOrBuilder
-
getLabelsOrDefault
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 2;
- Specified by:
getLabelsOrDefault
in interfaceTopicOrBuilder
-
getLabelsOrThrow
See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
map<string, string> labels = 2;
- Specified by:
getLabelsOrThrow
in interfaceTopicOrBuilder
-
hasMessageStoragePolicy
public boolean hasMessageStoragePolicy()Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
.google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3;
- Specified by:
hasMessageStoragePolicy
in interfaceTopicOrBuilder
- Returns:
- Whether the messageStoragePolicy field is set.
-
getMessageStoragePolicy
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
.google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3;
- Specified by:
getMessageStoragePolicy
in interfaceTopicOrBuilder
- Returns:
- The messageStoragePolicy.
-
getMessageStoragePolicyOrBuilder
Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored. If not present, then no constraints are in effect.
.google.pubsub.v1.MessageStoragePolicy message_storage_policy = 3;
- Specified by:
getMessageStoragePolicyOrBuilder
in interfaceTopicOrBuilder
-
getKmsKeyName
The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
string kms_key_name = 5;
- Specified by:
getKmsKeyName
in interfaceTopicOrBuilder
- Returns:
- The kmsKeyName.
-
getKmsKeyNameBytes
public com.google.protobuf.ByteString getKmsKeyNameBytes()The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
string kms_key_name = 5;
- Specified by:
getKmsKeyNameBytes
in interfaceTopicOrBuilder
- Returns:
- The bytes for kmsKeyName.
-
hasSchemaSettings
public boolean hasSchemaSettings()Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6;
- Specified by:
hasSchemaSettings
in interfaceTopicOrBuilder
- Returns:
- Whether the schemaSettings field is set.
-
getSchemaSettings
Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6;
- Specified by:
getSchemaSettings
in interfaceTopicOrBuilder
- Returns:
- The schemaSettings.
-
getSchemaSettingsOrBuilder
Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6;
- Specified by:
getSchemaSettingsOrBuilder
in interfaceTopicOrBuilder
-
getSatisfiesPzs
public boolean getSatisfiesPzs()Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
bool satisfies_pzs = 7;
- Specified by:
getSatisfiesPzs
in interfaceTopicOrBuilder
- Returns:
- The satisfiesPzs.
-
hasMessageRetentionDuration
public boolean hasMessageRetentionDuration()Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;
- Specified by:
hasMessageRetentionDuration
in interfaceTopicOrBuilder
- Returns:
- Whether the messageRetentionDuration field is set.
-
getMessageRetentionDuration
public com.google.protobuf.Duration getMessageRetentionDuration()Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;
- Specified by:
getMessageRetentionDuration
in interfaceTopicOrBuilder
- Returns:
- The messageRetentionDuration.
-
getMessageRetentionDurationOrBuilder
public com.google.protobuf.DurationOrBuilder getMessageRetentionDurationOrBuilder()Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;
- Specified by:
getMessageRetentionDurationOrBuilder
in interfaceTopicOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Topic parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Topic parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Topic parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Topic parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Topic parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Topic parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Topic parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Topic parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Topic parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Topic.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-