Class Topic (2.21.1)

Topic(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A topic resource.

Attributes

NameDescription
name :noindex: str
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
   :noindex:
          MutableMapping[str, str]
          

          Optional. See [Creating and managing labels]
   (https://cloud.google.com/pubsub/docs/labels).
        
message_storage_policy
   :noindex:
          google.pubsub_v1.types.MessageStoragePolicy
          

          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.
        
kms_key_name
   :noindex:
          str
          

          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/*.
        
schema_settings
   :noindex:
          google.pubsub_v1.types.SchemaSettings
          

          Optional. Settings for validating messages
   published against a schema.
        
satisfies_pzs
   :noindex:
          bool
          

          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.
        
message_retention_duration
   :noindex:
          google.protobuf.duration_pb2.Duration
          

          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 
state
   :noindex:
          google.pubsub_v1.types.Topic.State
          

          Output only. An output-only field indicating
   the state of the topic.
        
ingestion_data_source_settings
   :noindex:
          google.pubsub_v1.types.IngestionDataSourceSettings
          

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

  
Classes
  

  
LabelsEntry

  

    
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

  

  
The abstract base class for a message.



  
    
      
        
      
      
        
        
      
      
        
        
      
      
        
        
      
      
        
        
      
    
  
Parameters
NameDescription
kwargs
          dict
          

          
Keys and values corresponding to the fields of the message.


          
        
mapping
          Union[dict, .Message]
          

          
A dictionary or message to be used to determine the values for this message.


          
        
ignore_unknown_fields
          Optional(bool)
          

          
If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.


          
        

  
State

  

    
State(value)

  

  
The state of the topic.


Values:
    STATE_UNSPECIFIED (0):
        Default value. This value is unused.
    ACTIVE (1):
        The topic does not have any persistent
        errors.
    INGESTION_RESOURCE_ERROR (2):
        Ingestion from the data source has
        encountered a permanent error. See the more
        detailed error state in the corresponding
        ingestion source configuration.