target.apidocs.com.google.api.services.pubsub.model.Topic.html Maven / Gradle / Ivy
Topic (Cloud Pub/Sub API v1-rev20240918-2.0.0)
com.google.api.services.pubsub.model
Class Topic
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.pubsub.model.Topic
-
public final class Topic
extends com.google.api.client.json.GenericJson
A topic resource.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Cloud Pub/Sub API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Topic()
-
Method Summary
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getIngestionDataSourceSettings
public IngestionDataSourceSettings getIngestionDataSourceSettings()
Optional. Settings for ingestion from a data source into this topic.
- Returns:
- value or
null for none
-
setIngestionDataSourceSettings
public Topic setIngestionDataSourceSettings(IngestionDataSourceSettings ingestionDataSourceSettings)
Optional. Settings for ingestion from a data source into this topic.
- Parameters:
ingestionDataSourceSettings - ingestionDataSourceSettings or null for none
-
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`.
- Returns:
- value or
null for none
-
setKmsKeyName
public Topic setKmsKeyName(String kmsKeyName)
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`.
- Parameters:
kmsKeyName - kmsKeyName or null for none
-
getLabels
public Map<String,String> getLabels()
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
- Returns:
- value or
null for none
-
setLabels
public Topic setLabels(Map<String,String> labels)
Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
- Parameters:
labels - labels or null for none
-
getMessageRetentionDuration
public String 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](https://cloud.google.com/pubsub/docs/replay-
overview#seek_to_a_time) 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.
- Returns:
- value or
null for none
-
setMessageRetentionDuration
public Topic setMessageRetentionDuration(String messageRetentionDuration)
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](https://cloud.google.com/pubsub/docs/replay-
overview#seek_to_a_time) 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.
- Parameters:
messageRetentionDuration - messageRetentionDuration or null for none
-
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.
- Returns:
- value or
null for none
-
setMessageStoragePolicy
public Topic setMessageStoragePolicy(MessageStoragePolicy 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.
- Parameters:
messageStoragePolicy - messageStoragePolicy or null for none
-
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"`.
- Returns:
- value or
null for none
-
setName
public Topic setName(String name)
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"`.
- Parameters:
name - name or null for none
-
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.
- Returns:
- value or
null for none
-
setSatisfiesPzs
public Topic setSatisfiesPzs(Boolean satisfiesPzs)
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.
- Parameters:
satisfiesPzs - satisfiesPzs or null for none
-
getSchemaSettings
public SchemaSettings getSchemaSettings()
Optional. Settings for validating messages published against a schema.
- Returns:
- value or
null for none
-
setSchemaSettings
public Topic setSchemaSettings(SchemaSettings schemaSettings)
Optional. Settings for validating messages published against a schema.
- Parameters:
schemaSettings - schemaSettings or null for none
-
getState
public String getState()
Output only. An output-only field indicating the state of the topic.
- Returns:
- value or
null for none
-
setState
public Topic setState(String state)
Output only. An output-only field indicating the state of the topic.
- Parameters:
state - state or null for none
-
set
public Topic set(String fieldName,
Object value)
- Overrides:
set in class com.google.api.client.json.GenericJson
-
clone
public Topic clone()
- Overrides:
clone in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.