Class CreateSubscriptionRequest (1.14.3)

public final class CreateSubscriptionRequest extends GeneratedMessageV3 implements CreateSubscriptionRequestOrBuilder

Request for CreateSubscription.

Protobuf type google.cloud.pubsublite.v1.CreateSubscriptionRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SKIP_BACKLOG_FIELD_NUMBER

public static final int SKIP_BACKLOG_FIELD_NUMBER
Field Value
Type Description
int

SUBSCRIPTION_FIELD_NUMBER

public static final int SUBSCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

SUBSCRIPTION_ID_FIELD_NUMBER

public static final int SUBSCRIPTION_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateSubscriptionRequest getDefaultInstance()
Returns
Type Description
CreateSubscriptionRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateSubscriptionRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateSubscriptionRequest getDefaultInstanceForType()
Returns
Type Description
CreateSubscriptionRequest

getParent()

public String getParent()

Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkipBacklog()

public boolean getSkipBacklog()

If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false.

bool skip_backlog = 4;

Returns
Type Description
boolean

The skipBacklog.

getSubscription()

public Subscription getSubscription()

Required. Configuration of the subscription to create. Its name field is ignored.

.google.cloud.pubsublite.v1.Subscription subscription = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Subscription

The subscription.

getSubscriptionId()

public String getSubscriptionId()

Required. The ID to use for the subscription, which will become the final component of the subscription's name.

This value is structured like: my-sub-name.

string subscription_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The subscriptionId.

getSubscriptionIdBytes()

public ByteString getSubscriptionIdBytes()

Required. The ID to use for the subscription, which will become the final component of the subscription's name.

This value is structured like: my-sub-name.

string subscription_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for subscriptionId.

getSubscriptionOrBuilder()

public SubscriptionOrBuilder getSubscriptionOrBuilder()

Required. Configuration of the subscription to create. Its name field is ignored.

.google.cloud.pubsublite.v1.Subscription subscription = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SubscriptionOrBuilder

hasSubscription()

public boolean hasSubscription()

Required. Configuration of the subscription to create. Its name field is ignored.

.google.cloud.pubsublite.v1.Subscription subscription = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the subscription 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 CreateSubscriptionRequest.Builder newBuilderForType()
Returns
Type Description
CreateSubscriptionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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