Class Topic (1.126.6)

public final class Topic extends GeneratedMessageV3 implements TopicOrBuilder

A topic resource.

Protobuf type google.pubsub.v1.Topic

Implements

TopicOrBuilder

Static Fields

INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER

public static final int INGESTION_DATA_SOURCE_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_NAME_FIELD_NUMBER

public static final int KMS_KEY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_RETENTION_DURATION_FIELD_NUMBER

public static final int MESSAGE_RETENTION_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_STORAGE_POLICY_FIELD_NUMBER

public static final int MESSAGE_STORAGE_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEMA_SETTINGS_FIELD_NUMBER

public static final int SCHEMA_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Topic getDefaultInstance()
Returns
TypeDescription
Topic

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Topic.Builder newBuilder()
Returns
TypeDescription
Topic.Builder

newBuilder(Topic prototype)

public static Topic.Builder newBuilder(Topic prototype)
Parameter
NameDescription
prototypeTopic
Returns
TypeDescription
Topic.Builder

parseDelimitedFrom(InputStream input)

public static Topic parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Topic
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Topic parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Topic
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Topic parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Topic
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Topic parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Topic
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Topic parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Topic
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Topic parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Topic
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Topic parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Topic
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Topic parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Topic
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Topic parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Topic
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Topic parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Topic
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Topic parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Topic
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Topic parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Topic
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Topic> parser()
Returns
TypeDescription
Parser<Topic>

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];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Topic getDefaultInstanceForType()
Returns
TypeDescription
Topic

getIngestionDataSourceSettings()

public IngestionDataSourceSettings getIngestionDataSourceSettings()

Optional. Settings for managed ingestion from a data source into this topic.

.google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IngestionDataSourceSettings

The ingestionDataSourceSettings.

getIngestionDataSourceSettingsOrBuilder()

public IngestionDataSourceSettingsOrBuilder getIngestionDataSourceSettingsOrBuilder()

Optional. Settings for managed ingestion from a data source into this topic.

.google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IngestionDataSourceSettingsOrBuilder

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
TypeDescription
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
TypeDescription
ByteString

The bytes for kmsKeyName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. See Creating and managing labels.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. See Creating and managing labels.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Map<String,String>

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];

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. See Creating and managing labels.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
DurationOrBuilder

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];

Returns
TypeDescription
MessageStoragePolicy

The messageStoragePolicy.

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];

Returns
TypeDescription
MessageStoragePolicyOrBuilder

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];

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Topic> getParserForType()
Returns
TypeDescription
Parser<Topic>
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
TypeDescription
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];

Returns
TypeDescription
SchemaSettings

The schemaSettings.

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];

Returns
TypeDescription
SchemaSettingsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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];

Returns
TypeDescription
Topic.State

The state.

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
TypeDescription
int

The enum numeric value on the wire for state.

hasIngestionDataSourceSettings()

public boolean hasIngestionDataSourceSettings()

Optional. Settings for managed ingestion from a data source into this topic.

.google.pubsub.v1.IngestionDataSourceSettings ingestion_data_source_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the schemaSettings field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Topic.Builder newBuilderForType()
Returns
TypeDescription
Topic.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Topic.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Topic.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Topic.Builder toBuilder()
Returns
TypeDescription
Topic.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException