public final class Topic extends GeneratedMessageV3 implements TopicOrBuilder
A topic resource.
Protobuf type google.pubsub.v1.Topic
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
public static final int INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KMS_KEY_NAME_FIELD_NUMBER
public static final int KMS_KEY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
public static final int MESSAGE_STORAGE_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MESSAGE_TRANSFORMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCHEMA_SETTINGS_FIELD_NUMBER
public static final int SCHEMA_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Topic getDefaultInstance()
| Returns |
| Type |
Description |
Topic |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Topic.Builder newBuilder()
newBuilder(Topic prototype)
public static Topic.Builder newBuilder(Topic prototype)
| Parameter |
| Name |
Description |
prototype |
Topic
|
public static Topic parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Topic |
|
public static Topic parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Topic |
|
parseFrom(byte[] data)
public static Topic parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Topic |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Topic parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Topic |
|
parseFrom(ByteString data)
public static Topic parseFrom(ByteString data)
| Returns |
| Type |
Description |
Topic |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Topic parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Topic |
|
public static Topic parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Topic |
|
public static Topic parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Topic |
|
public static Topic parseFrom(InputStream input)
| Returns |
| Type |
Description |
Topic |
|
public static Topic parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Topic |
|
parseFrom(ByteBuffer data)
public static Topic parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Topic |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Topic parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Topic |
|
parser()
public static Parser<Topic> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Topic getDefaultInstanceForType()
| Returns |
| Type |
Description |
Topic |
|
getIngestionDataSourceSettings()
public IngestionDataSourceSettings getIngestionDataSourceSettings()
Optional. Settings for ingestion from a data source into this topic.
.google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
getIngestionDataSourceSettingsOrBuilder()
public IngestionDataSourceSettingsOrBuilder getIngestionDataSourceSettingsOrBuilder()
Optional. Settings for ingestion from a data source into this topic.
.google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
getKmsKeyName()
public String getKmsKeyName()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The kmsKeyName.
|
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for kmsKeyName.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getMessageRetentionDuration()
public Duration getMessageRetentionDuration()
Optional. 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
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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Duration |
The messageRetentionDuration.
|
getMessageRetentionDurationOrBuilder()
public DurationOrBuilder getMessageRetentionDurationOrBuilder()
Optional. 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
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 [(.google.api.field_behavior) = OPTIONAL];
getMessageStoragePolicy()
public MessageStoragePolicy getMessageStoragePolicy()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
getMessageStoragePolicyOrBuilder()
public MessageStoragePolicyOrBuilder getMessageStoragePolicyOrBuilder()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
public MessageTransform getMessageTransforms(int index)
Optional. Transforms to be applied to messages published to the topic.
Transforms are applied in the order specified.
repeated .google.pubsub.v1.MessageTransform message_transforms = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public int getMessageTransformsCount()
Optional. Transforms to be applied to messages published to the topic.
Transforms are applied in the order specified.
repeated .google.pubsub.v1.MessageTransform message_transforms = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public List<MessageTransform> getMessageTransformsList()
Optional. Transforms to be applied to messages published to the topic.
Transforms are applied in the order specified.
repeated .google.pubsub.v1.MessageTransform message_transforms = 13 [(.google.api.field_behavior) = OPTIONAL];
public MessageTransformOrBuilder getMessageTransformsOrBuilder(int index)
Optional. Transforms to be applied to messages published to the topic.
Transforms are applied in the order specified.
repeated .google.pubsub.v1.MessageTransform message_transforms = 13 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends MessageTransformOrBuilder> getMessageTransformsOrBuilderList()
Optional. Transforms to be applied to messages published to the topic.
Transforms are applied in the order specified.
repeated .google.pubsub.v1.MessageTransform message_transforms = 13 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.pubsub.v1.MessageTransformOrBuilder> |
|
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];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Topic> getParserForType()
Overrides
getSatisfiesPzs()
public boolean getSatisfiesPzs()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The satisfiesPzs.
|
getSchemaSettings()
public SchemaSettings getSchemaSettings()
Optional. Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
getSchemaSettingsOrBuilder()
public SchemaSettingsOrBuilder getSchemaSettingsOrBuilder()
Optional. Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public Topic.State getState()
Output only. An output-only field indicating the state of the topic.
.google.pubsub.v1.Topic.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. An output-only field indicating the state of the topic.
.google.pubsub.v1.Topic.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
hasIngestionDataSourceSettings()
public boolean hasIngestionDataSourceSettings()
Optional. Settings for ingestion from a data source into this topic.
.google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the ingestionDataSourceSettings field is set.
|
hasMessageRetentionDuration()
public boolean hasMessageRetentionDuration()
Optional. 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
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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the messageRetentionDuration field is set.
|
hasMessageStoragePolicy()
public boolean hasMessageStoragePolicy()
Optional. 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the messageStoragePolicy field is set.
|
hasSchemaSettings()
public boolean hasSchemaSettings()
Optional. Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the schemaSettings field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Topic.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Topic.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Topic.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
