Reference documentation and code samples for the Cloud PubSub V1 Client class Topic.
A topic resource.
Generated from protobuf message google.pubsub.v1.Topic
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
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"
.
↳ labels
↳ message_storage_policy
Google\Cloud\PubSub\V1\MessageStoragePolicy
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.
↳ kms_key_name
string
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/*
.
↳ schema_settings
↳ satisfies_pzs
bool
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
↳ message_retention_duration
Google\Protobuf\Duration
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.
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
setName
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"
.
var
string
$this
getLabels
setLabels
$this
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.
hasMessageStoragePolicy
clearMessageStoragePolicy
setMessageStoragePolicy
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.
$this
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
setKmsKeyName
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/*
.
var
string
$this
getSchemaSettings
Settings for validating messages published against a schema.
hasSchemaSettings
clearSchemaSettings
setSchemaSettings
Settings for validating messages published against a schema.
$this
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
setSatisfiesPzs
Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
var
bool
$this
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 31 days or less than 10 minutes.
hasMessageRetentionDuration
clearMessageRetentionDuration
setMessageRetentionDuration
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.
$this
