public
final
class
Topic
extends
GeneratedMessageV3
implements
TopicOrBuilder
A topic resource.
Protobuf type google.pubsub.v1.Topic
Static Fields
KMS_KEY_NAME_FIELD_NUMBER
public
static
final
int
KMS_KEY_NAME_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public
static
final
int
LABELS_FIELD_NUMBER
Field Value
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
public
static
final
int
MESSAGE_RETENTION_DURATION_FIELD_NUMBER
Field Value
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
public
static
final
int
MESSAGE_STORAGE_POLICY_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
Field Value
SATISFIES_PZS_FIELD_NUMBER
public
static
final
int
SATISFIES_PZS_FIELD_NUMBER
Field Value
SCHEMA_SETTINGS_FIELD_NUMBER
public
static
final
int
SCHEMA_SETTINGS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Topic
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Topic
.
Builder
newBuilder
()
Returns
newBuilder(Topic prototype)
public
static
Topic
.
Builder
newBuilder
(
Topic
prototype
)
Parameter
Returns
public
static
Topic
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Topic
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Topic
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Topic
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Topic
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
public
static
Topic
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
public
static
Topic
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
public
static
Topic
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Topic
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Topic
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Topic>
parser
()
Returns
Methods
containsLabels(String key)
public
boolean
containsLabels
(
String
key
)
Parameter
Returns
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public
Topic
getDefaultInstanceForType
()
Returns
getKmsKeyName()
public
String
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;
Returns
getKmsKeyNameBytes()
public
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;
Returns | Type |
Description |
| ByteString
|
The bytes for kmsKeyName.
|
getLabels()
public
Map<String
,
String
>
getLabels
()
Returns
getLabelsCount()
public
int
getLabelsCount
()
Returns
getLabelsMap()
public
Map<String
,
String
>
getLabelsMap
()
Returns
getLabelsOrDefault(String key, String defaultValue)
public
String
getLabelsOrDefault
(
String
key
,
String
defaultValue
)
Parameters
Returns
getLabelsOrThrow(String key)
public
String
getLabelsOrThrow
(
String
key
)
Parameter
Returns
getMessageRetentionDuration()
public
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
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 7 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;
Returns | Type |
Description |
| Duration
|
The messageRetentionDuration.
|
getMessageRetentionDurationOrBuilder()
public
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
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 7 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;
Returns
getMessageStoragePolicy()
public
MessageStoragePolicy
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;
Returns
getMessageStoragePolicyOrBuilder()
public
MessageStoragePolicyOrBuilder
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;
Returns
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
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
getParserForType()
public
Parser<Topic>
getParserForType
()
Returns
Overrides
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;
Returns
getSchemaSettings()
public
SchemaSettings
getSchemaSettings
()
Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6;
Returns
getSchemaSettingsOrBuilder()
public
SchemaSettingsOrBuilder
getSchemaSettingsOrBuilder
()
Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6;
Returns
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
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
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 7 days or less than 10 minutes.
.google.protobuf.Duration message_retention_duration = 8;
Returns | Type |
Description |
| boolean
|
Whether the messageRetentionDuration field is set.
|
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;
Returns | Type |
Description |
| boolean
|
Whether the messageStoragePolicy field is set.
|
hasSchemaSettings()
public
boolean
hasSchemaSettings
()
Settings for validating messages published against a schema.
.google.pubsub.v1.SchemaSettings schema_settings = 6;
Returns | Type |
Description |
| boolean
|
Whether the schemaSettings field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
Parameter
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Topic
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Topic
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Topic
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
