public
final
class
Topic
extends
GeneratedMessageV3
implements
TopicOrBuilder
A topic resource.
Protobuf type google.pubsub.v1.Topic
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TopicImplements
TopicOrBuilderStatic Fields
INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
public
static
final
int
INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
KMS_KEY_NAME_FIELD_NUMBER
public
static
final
int
KMS_KEY_NAME_FIELD_NUMBER
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public
static
final
int
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
public
static
final
int
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
MESSAGE_TRANSFORMS_FIELD_NUMBER
public
static
final
int
MESSAGE_TRANSFORMS_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
SATISFIES_PZS_FIELD_NUMBER
public
static
final
int
SATISFIES_PZS_FIELD_NUMBER
SCHEMA_SETTINGS_FIELD_NUMBER
public
static
final
int
SCHEMA_SETTINGS_FIELD_NUMBER
STATE_FIELD_NUMBER
public
static
final
int
STATE_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Topic
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Topic
.
Builder
newBuilder
()
newBuilder(Topic prototype)
public
static
Topic
.
Builder
newBuilder
(
Topic
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Topic
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Topic
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Topic
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Topic
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Topic
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Topic
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Topic>
parser
()
Methods
containsLabels(String key)
public
boolean
containsLabels
(
String
key
)
Optional. See Creating and managing labels .
map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public
boolean
equals
(
Object
obj
)
getDefaultInstanceForType()
public
Topic
getDefaultInstanceForType
()
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];
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];
getLabels() (deprecated)
public
Map<String
,
String
>
getLabels
()
Use #getLabelsMap() instead.
getLabelsCount()
public
int
getLabelsCount
()
Optional. See Creating and managing labels .
map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
getLabelsMap()
public
Map<String
,
String
>
getLabelsMap
()
Optional. See Creating and managing labels .
map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public
String
getLabelsOrDefault
(
String
key
,
String
defaultValue
)
Optional. See Creating and managing labels .
map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public
String
getLabelsOrThrow
(
String
key
)
Optional. See Creating and managing labels .
map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
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];
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];
getMessageTransforms(int index)
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];
getMessageTransformsCount()
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];
getMessageTransformsList()
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];
getMessageTransformsOrBuilder(int index)
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];
getMessageTransformsOrBuilderList()
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];
getName()
public
String
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];
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];
getParserForType()
public
Parser<Topic>
getParserForType
()
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];
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
()
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];
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];
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];
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];
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];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
internalGetMapFieldReflection(int number)
protected
MapFieldReflectionAccessor
internalGetMapFieldReflection
(
int
number
)
com.google.protobuf.MapFieldReflectionAccessor
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Topic
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Topic
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Topic
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
