publicfinalclassTopicextendsGeneratedMessageimplementsTopicOrBuilder
A topic resource.
Protobuf typegoogle.pubsub.v1.Topic
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
publicstaticfinalintINGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_NAME_FIELD_NUMBER
publicstaticfinalintKMS_KEY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
publicstaticfinalintMESSAGE_RETENTION_DURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
publicstaticfinalintMESSAGE_STORAGE_POLICY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MESSAGE_TRANSFORMS_FIELD_NUMBER
publicstaticfinalintMESSAGE_TRANSFORMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SATISFIES_PZS_FIELD_NUMBER
publicstaticfinalintSATISFIES_PZS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCHEMA_SETTINGS_FIELD_NUMBER
publicstaticfinalintSCHEMA_SETTINGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
publicstaticfinalintSTATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TAGS_FIELD_NUMBER
publicstaticfinalintTAGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticTopicgetDefaultInstance()
| Returns |
|---|
| Type | Description |
Topic | |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticTopic.BuildernewBuilder()
newBuilder(Topic prototype)
publicstaticTopic.BuildernewBuilder(Topicprototype)
| Parameter |
|---|
| Name | Description |
prototype | Topic
|
parseDelimitedFrom(InputStream input)
publicstaticTopicparseDelimitedFrom(InputStreaminput)
| Returns |
|---|
| Type | Description |
Topic | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticTopicparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(byte[] data)
publicstaticTopicparseFrom(byte[]data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticTopicparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(ByteString data)
publicstaticTopicparseFrom(ByteStringdata)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticTopicparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(CodedInputStream input)
publicstaticTopicparseFrom(CodedInputStreaminput)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticTopicparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(InputStream input)
publicstaticTopicparseFrom(InputStreaminput)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticTopicparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(ByteBuffer data)
publicstaticTopicparseFrom(ByteBufferdata)
| Returns |
|---|
| Type | Description |
Topic | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticTopicparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Topic | |
parser()
publicstaticParser<Topic>parser()
Methods
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)
| Parameter |
|---|
| Name | Description |
key | String
|
containsTags(String key)
publicbooleancontainsTags(Stringkey)
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Seehttps://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.
map<string, string> tags = 14 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetDefaultInstanceForType()
publicTopicgetDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Topic | |
getIngestionDataSourceSettings()
publicIngestionDataSourceSettingsgetIngestionDataSourceSettings()
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()
publicIngestionDataSourceSettingsOrBuildergetIngestionDataSourceSettingsOrBuilder()
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()
publicStringgetKmsKeyName()
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
The expected format isprojects/*/locations/*/keyRings/*/cryptoKeys/*.
string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
String | The kmsKeyName. |
getKmsKeyNameBytes()
publicByteStringgetKmsKeyNameBytes()
Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic.
The expected format isprojects/*/locations/*/keyRings/*/cryptoKeys/*.
string kms_key_name = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kmsKeyName. |
getLabels() (deprecated)
publicMap<String,String>getLabels()
getLabelsCount()
publicintgetLabelsCount()
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
publicMap<String,String>getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)
| Parameter |
|---|
| Name | Description |
key | String
|
getMessageRetentionDuration()
publicDurationgetMessageRetentionDuration()
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 lastmessage_retention_duration are always available to subscribers. For instance, it allows any attached subscription toseek to a timestamp that is up tomessage_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()
publicDurationOrBuildergetMessageRetentionDurationOrBuilder()
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 lastmessage_retention_duration are always available to subscribers. For instance, it allows any attached subscription toseek to a timestamp that is up tomessage_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()
publicMessageStoragePolicygetMessageStoragePolicy()
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()
publicMessageStoragePolicyOrBuildergetMessageStoragePolicyOrBuilder()
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)
publicMessageTransformgetMessageTransforms(intindex)
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
|
getMessageTransformsCount()
publicintgetMessageTransformsCount()
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 | |
getMessageTransformsList()
publicList<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)
publicMessageTransformOrBuildergetMessageTransformsOrBuilder(intindex)
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
|
getMessageTransformsOrBuilderList()
publicList<?extendsMessageTransformOrBuilder>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. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
| Returns |
|---|
| Type | Description |
String | The name. |
getNameBytes()
publicByteStringgetNameBytes()
Required. Identifier. 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, (.google.api.field_behavior) = IDENTIFIER];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name. |
getParserForType()
publicParser<Topic>getParserForType()
getSatisfiesPzs()
publicbooleangetSatisfiesPzs()
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()
publicSchemaSettingsgetSchemaSettings()
Optional. Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
getSchemaSettingsOrBuilder()
publicSchemaSettingsOrBuildergetSchemaSettingsOrBuilder()
Optional. Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
publicintgetSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverridesgetState()
publicTopic.StategetState()
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()
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. |
getTags() (deprecated)
publicMap<String,String>getTags()
getTagsCount()
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Seehttps://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.
map<string, string> tags = 14 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
getTagsMap()
publicMap<String,String>getTagsMap()
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Seehttps://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.
map<string, string> tags = 14 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getTagsOrDefault(String key, String defaultValue)
publicStringgetTagsOrDefault(Stringkey,StringdefaultValue)
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Seehttps://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.
map<string, string> tags = 14 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
getTagsOrThrow(String key)
publicStringgetTagsOrThrow(Stringkey)
Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Seehttps://docs.cloud.google.com/pubsub/docs/tags for more information on using tags with Pub/Sub resources.
map<string, string> tags = 14 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
hasIngestionDataSourceSettings()
publicbooleanhasIngestionDataSourceSettings()
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()
publicbooleanhasMessageRetentionDuration()
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 lastmessage_retention_duration are always available to subscribers. For instance, it allows any attached subscription toseek to a timestamp that is up tomessage_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()
publicbooleanhasMessageStoragePolicy()
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()
publicbooleanhasSchemaSettings()
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 | |
OverridesinternalGetFieldAccessorTable()
protectedGeneratedMessage.FieldAccessorTableinternalGetFieldAccessorTable()
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overridescom.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
isInitialized()
publicfinalbooleanisInitialized()
newBuilderForType()
publicTopic.BuildernewBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protectedTopic.BuildernewBuilderForType(AbstractMessage.BuilderParentparent)
toBuilder()
publicTopic.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
