Class Subscription (1.13.5)

public final class Subscription extends GeneratedMessageV3 implements SubscriptionOrBuilder

Metadata about a subscription resource.

Protobuf type google.cloud.pubsublite.v1.Subscription

Static Fields

DELIVERY_CONFIG_FIELD_NUMBER

public static final int DELIVERY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

EXPORT_CONFIG_FIELD_NUMBER

public static final int EXPORT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TOPIC_FIELD_NUMBER

public static final int TOPIC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Subscription getDefaultInstance()
Returns
Type Description
Subscription

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Subscription.Builder newBuilder()
Returns
Type Description
Subscription.Builder

newBuilder(Subscription prototype)

public static Subscription.Builder newBuilder(Subscription prototype)
Parameter
Name Description
prototype Subscription
Returns
Type Description
Subscription.Builder

parseDelimitedFrom(InputStream input)

public static Subscription parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Subscription
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Subscription parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subscription
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Subscription parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Subscription
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Subscription parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subscription
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Subscription parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Subscription
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Subscription parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subscription
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Subscription parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Subscription
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Subscription parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subscription
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Subscription parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Subscription
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Subscription parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subscription
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Subscription parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Subscription
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Subscription parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Subscription
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Subscription> parser()
Returns
Type Description
Parser<Subscription>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Subscription getDefaultInstanceForType()
Returns
Type Description
Subscription

getDeliveryConfig()

public Subscription.DeliveryConfig getDeliveryConfig()

The settings for this subscription's message delivery.

.google.cloud.pubsublite.v1.Subscription.DeliveryConfig delivery_config = 3;

Returns
Type Description
Subscription.DeliveryConfig

The deliveryConfig.

getDeliveryConfigOrBuilder()

public Subscription.DeliveryConfigOrBuilder getDeliveryConfigOrBuilder()

The settings for this subscription's message delivery.

.google.cloud.pubsublite.v1.Subscription.DeliveryConfig delivery_config = 3;

Returns
Type Description
Subscription.DeliveryConfigOrBuilder

getExportConfig()

public ExportConfig getExportConfig()

If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.

.google.cloud.pubsublite.v1.ExportConfig export_config = 4;

Returns
Type Description
ExportConfig

The exportConfig.

getExportConfigOrBuilder()

public ExportConfigOrBuilder getExportConfigOrBuilder()

If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.

.google.cloud.pubsublite.v1.ExportConfig export_config = 4;

Returns
Type Description
ExportConfigOrBuilder

getName()

public String getName()

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Subscription> getParserForType()
Returns
Type Description
Parser<Subscription>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTopic()

public String getTopic()

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

string topic = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The topic.

getTopicBytes()

public ByteString getTopicBytes()

The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

string topic = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for topic.

hasDeliveryConfig()

public boolean hasDeliveryConfig()

The settings for this subscription's message delivery.

.google.cloud.pubsublite.v1.Subscription.DeliveryConfig delivery_config = 3;

Returns
Type Description
boolean

Whether the deliveryConfig field is set.

hasExportConfig()

public boolean hasExportConfig()

If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination.

.google.cloud.pubsublite.v1.ExportConfig export_config = 4;

Returns
Type Description
boolean

Whether the exportConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Subscription.Builder newBuilderForType()
Returns
Type Description
Subscription.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Subscription.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Subscription.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Subscription.Builder toBuilder()
Returns
Type Description
Subscription.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException